For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Get Started
API Reference
Python SDK
CLI
- Overview

Introduction
Quickstart
Authentication
Liveness
Readiness
Clerk Webhook
Stripe Webhook
Whoami
List Api Keys
Create Api Key
Get Api Key
Delete Api Key
Update Api Key
Rotate Api Key
List Dictionary Entries
Create Dictionary Entry
Search Dictionary Entries
List Dictionary Languages
Suggest Pronunciation
Update Dictionary Entry
Delete Dictionary Entry
List Nodes
Get Node Detail
List Provider Keys
Put Provider Key
Delete Provider Key
List Templates
Create Template
Get Template
Delete Template
Update Template
Estimate Template
Clone Template
Favorite Template
Unfavorite Template
List Voices
Get Voice
Get Similar Voices
Favorite Voice
Unfavorite Voice
Get Workspace Settings
Workspace Runs Stats
Workspace Workflows Stats
List Members
Create Invite
Remove Member
Update Member Role
Revoke Invite
Update Invite Role
Accept Invite
List Workspaces
Create Workspace
Get Workspace
Delete Workspace
Update Workspace
Create Upload
Confirm Upload
Delete Upload
Usage Summary
Usage By Language
Usage Activity
List Plans
Preview Plan Change
Create Checkout
Get Current Subscription
Subscribe
Cancel Subscription
Change Plan
Cancel Scheduled Change
List Payment Methods
Add Payment Method
Delete Payment Method
Set Default Payment Method
Get My Credits
Get My Plan Limits
List Invoices
Get Current Notification Preferences
Update Current Notification Preferences
List My Templates
List Workflows
Create Workflow
Get Workflow
Update Workflow
Delete Workflow
Patch Workflow
List Workflow Uploads
Estimate Workflow
Preview Run
Runs Summary
Get Run Steps
Get Run Overview
Get Run Data
Download Run
Download Run Node
Duplicate Workflow
List Runs
Start Run
Get Run
Get Run Status
Cancel Run
Install
Usage
Errors
Overview
login
workflows
voices
templates
uploads

API Reference health

Readiness

GET

/ready

GET

/ready

$ curl https://api.onepin.ai/ready

Readiness probe — checks DB and Redis connectivity.

Response

Successful Response

Was this page helpful?