Requests use the API gateway and your account token. Calls may consume credits.Sign in
API endpoints and playground
Parameters
No parameters.
Responses
200
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
202
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
ptu_id
query
['integer', 'null']
No
api-subscription-key
header
string
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
api-subscription-key
header
string
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Success. Returns a streamed audio response in the requested format (e.g., `audio/mpeg` for MP3, `audio/wav` for WAV).
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
201
Voice created successfully. Usable immediately with POST /voices/clone.
400
Bad Request. Unsupported audio format, file over 50 MB, or a Studio-only field (`consent`, `passage_id`, `noise_reduction`, `enable_noise_reduction`, `accent`, `ref_text`) was sent. Use `remove_background_noise` instead of `noise_reduction` / `enable_noise_reduction`.
401
Unauthorized. The `api-subscription-key` header is missing or invalid.
403
Forbidden. Your organization has reached the Starter (pay as you go) plan's limit of 50 saved voices. Pro and Enterprise plans have higher limits. Delete a voice to free a slot.
422
Validation Error. Missing required fields, or the reference audio failed quality/ASR validation (too noisy, too short, or no clear single speaker).
500
Internal Server Error.
502
Bad Gateway. The cloning model failed to generate the voice. Safe to retry.
503
Service Unavailable. The cloning model is temporarily overloaded.
504
Gateway Timeout. The clone took too long to complete.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
200
Successful Response
400
Bad Request. Missing both `ref_audio` and `voice_id`, both provided, empty `text`, language not detected or unsupported (including Urdu and romanized Indic), invalid duration range, or `ref_audio` over 10 MB / 15 seconds.
402
Quota Exceeded
403
Forbidden. The `api-subscription-key` is missing, malformed, invalid.
422
Unprocessable Entity. The form fields failed validation; the body is invalid. Check enum values and required fields.
429
Rate Limit Exceeded. Retry with exponential backoff.
500
Internal Server Error. Model unavailable, generation failed, or QC could not produce a passing output. Retry once; if it persists, log the `request_id` and contact support.
502
Billing Service Unavailable. The billing service could not record usage for this request. Retry with exponential backoff; if it persists, contact support with the request_id.
503
Model Unavailable or Overloaded. The model call failed or the model is overloaded. Retry with exponential backoff.
504
Gateway Timeout. The model call timed out. Retry with exponential backoff.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
200
Success. Returns a streamed audio response in the requested format (e.g., `audio/mpeg` for MP3, `audio/wav` for WAV).
400
Bad Request. Missing both `ref_audio` and `voice_id`, both provided, empty `text`, unsupported stream codec, or `ref_audio` over 10 MB / 15 seconds.
402
Quota Exceeded
403
Forbidden. The `api-subscription-key` is missing, malformed, invalid.
422
Unprocessable Entity. The form fields failed validation; the body is invalid. Check enum values and required fields.
429
Rate Limit Exceeded. Retry with exponential backoff.
500
Internal Server Error. Model unavailable or generation failed before the first audio byte. Retry once; if it persists, log the `request_id` and contact support.
502
Billing Service Unavailable. The billing service could not record usage for this request. Retry with exponential backoff; if it persists, contact support with the request_id.
503
Model Unavailable or Overloaded. The model call failed or the model is overloaded. Retry with exponential backoff.
504
Gateway Timeout. The model call timed out. Retry with exponential backoff.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
search
query
string
No
gender
query
string
No
accent
query
string
No
limit
query
integer
No
offset
query
integer
No
Responses
200
A page of cloned voices.
401
Unauthorized. The `api-subscription-key` header is missing or invalid.
500
Internal Server Error.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
voice_id
path
string
Yes
Responses
200
Voice details with signed audio URLs.
401
Unauthorized. The `api-subscription-key` header is missing or invalid.
404
Not Found. No voice with this ID exists in your workspace.
500
Internal Server Error.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
voice_id
path
string
Yes
Responses
204
Voice deleted successfully. No response body.
401
Unauthorized. The `api-subscription-key` header is missing or invalid.
404
Not Found. No voice with this ID exists in your workspace.
500
Internal Server Error.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
200
Detection completed.
400
Bad Request. Unsupported audio format, empty file, or file over 10 MB.
401
Unauthorized. The `api-subscription-key` header is missing or invalid.
429
Too Many Requests. Default rate limit is 5 requests per minute.
500
Internal Server Error. Watermark detection failed or is unavailable.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
200
Successful Response
400
Bad Request — Invalid JSON, missing required fields, or bad schema.
403
Forbidden
413
Payload Too Large — File size exceeds the 1 MB limit.
422
Unprocessable Entity — Word limit exceeded (>100 words per dictionary) or dictionary limit exceeded (>10 dictionaries per user).
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
200
Successful Response
400
Bad Request — Invalid JSON, missing required fields, or bad schema.
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
dict_id
query
string
Yes
Responses
200
Successful Response
400
Bad Request — Invalid JSON, missing required fields, or bad schema.
403
Forbidden
404
Not Found — Dictionary not found.
413
Payload Too Large — File size exceeds the 1 MB limit.
422
Unprocessable Entity — Word limit exceeded (>100 words per dictionary).
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
dict_id
query
string
Yes
Responses
200
Successful Response
400
Bad Request — Invalid JSON, missing required fields, or bad schema.
403
Forbidden
404
Not Found — Dictionary not found.
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
dict_id
path
string
Yes
Responses
200
Successful Response
400
Bad Request — Invalid JSON, missing required fields, or bad schema.
403
Forbidden
404
Not Found — Dictionary not found.
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
x-session-affinity
header
string
No
requestBody
body
json
No
Responses
200
Successful Response
400
Invalid request — wrong types or shapes in the JSON body (the gateway may return a serde-style message such as a field that expected a boolean receiving a string), unsupported parameters, model capability mismatch (e.g. image to a text-only model, remote image URL), or the context-window guard (prompt plus requested completion budget exceeds the model limit). The response includes `error.message` and, when present, `error.request_id` for support.
401
Missing or invalid API key — returned as 403 invalid_api_key_error in practice.
402
No credits remain (`insufficient_quota_error`). Add credits in the dashboard.
403
Missing or invalid API key (`invalid_api_key_error`).
404
Unknown or wrongly cased model id (`not_found_error`). Model ids are case-sensitive.
413
Serialised request body larger than 10,485,760 bytes (10 MB), including text and inline image data.
429
Rate limit exceeded, or account seat budget exhausted.
502
The model backend could not be reached (`model_call_failed`). Retry the request.
503
Model overloaded (`model_overloaded`). Retry with backoff.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
model_id
path
string
Yes
Responses
200
Successful Response
404
Model not served by this deployment.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
200
Successful Response
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
400
Invalid or refused request — unsupported parameter values, stateful fields such as `store: true`, `background: true`, `previous_response_id`, `conversation`, `max_tool_calls`, `prompt`, or `item_reference`, capability mismatch, or context-window guard (input plus `max_output_tokens` exceeds the model limit). Response body includes `error.message` and, when present, `error.request_id`.
401
Missing or invalid API key — returned as 403 invalid_api_key_error in practice.
402
No credits remain (`insufficient_quota_error`). Add credits in the dashboard.
403
Missing or invalid API key (`invalid_api_key_error`).
404
Unknown or wrongly cased model id (`not_found_error`), or `GET /v2/responses/{id}` when retrieval is not supported.
413
Serialised request body larger than 10,485,760 bytes (10 MB), including text and inline image data.
429
Rate limit exceeded (`rate_limit_exceeded_error` or `model_rate_limit_exceeded_error`).
502
The model request failed (`model_call_failed`). Retry the request; contact support if the error persists.
503
Model overloaded (`model_overloaded`).
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Successful Response
400
Invalid request (`invalid_request_error`): the body is not valid JSON, the body is not a JSON object, `model` is missing or not a string, or an image is sent as a URL.
402
Payment Required — Insufficient credits to complete this operation (`insufficient_quota_error`).
403
Missing or invalid API key (`invalid_api_key_error`).
404
Unknown model ID (`not_found_error`). Model IDs are case-sensitive.
422
The request is invalid: a missing `state` or `questions`, an unsupported question `type` or key, options outside 2–255 or levels outside 2–10, a refused generation field, or a question over the 32,768-token limit (`unprocessable_entity_error`). `param` gives the path to the field at fault.
429
Rate limit exceeded (`rate_limit_exceeded_error`): too many requests per minute, or the token budget is used up. Retry with backoff.
500
An internal error occurred (`internal_server_error`).
502
The model backend could not be reached (`model_call_failed`). Retry the request.
503
Model overloaded or starting up, or the request took longer than 60 seconds (`model_overloaded`). Retry with backoff; for a large request, split the questions across smaller requests first.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
api-subscription-key
header
['string', 'null']
No
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request. The request failed validation; `message` names each failing field.
401
Unauthorized. Send a valid `api-subscription-key`.
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
Responses
200
Successful Response
400
Bad Request. The request failed validation; `message` names each failing field.
401
Unauthorized. Send a valid `api-subscription-key`.
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
Responses
200
Successful Response
400
Bad Request. The request failed validation; `message` names each failing field.
401
Unauthorized. Send a valid `api-subscription-key`.
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
limit
query
integer
No
Responses
200
Successful Response
400
Bad Request. The request failed validation; `message` names each failing field.
401
Unauthorized. Send a valid `api-subscription-key`.
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
201
Job created.
400
Bad Request — Invalid language code, genre, or filename.
401
Unauthorized. Send a valid `api-subscription-key`.
402
Payment Required — Insufficient credits to complete this operation.
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
Responses
200
Job started.
400
Bad Request — Validation error (invalid or missing field).
401
Unauthorized. Send a valid `api-subscription-key`.
402
Payment Required — Insufficient credits to complete this operation.
404
Not Found — No job exists for this job_id.
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
Responses
200
Live status.
400
Bad Request — Validation error (invalid or missing field).
401
Unauthorized. Send a valid `api-subscription-key`.
404
Not Found — No job exists for this job_id.
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
lang
query
string
Yes
format
query
string
No
fit_line_height
query
boolean
No
fit_font_shrink
query
boolean
No
Responses
202
Export enqueued.
400
Bad Request — Unsupported export format or invalid language code.
401
Unauthorized. Send a valid `api-subscription-key`.
404
Not Found — No job exists for this job_id.
409
Export already in progress for this language and format.
500
Internal Server Error
503
Service Unavailable — Export enqueue failed. Please retry.
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
lang
query
string
No
export_id
query
string
No
Responses
200
Export status.
400
Bad Request — Validation error (invalid or missing field).
401
Unauthorized. Send a valid `api-subscription-key`.
404
Not Found — No export job found for the given export_id or lang.
500
Internal Server Error
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
201
Created
400
Invalid request
402
Billing or entitlement error
403
Forbidden
429
Rate or admission limit exceeded
503
Billing unavailable
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
201
Created
400
Invalid request or schema
402
Billing or entitlement error
403
Forbidden
413
File too large
429
Rate or admission limit exceeded
503
Billing unavailable
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
201
Created
400
Invalid request or schema
402
Billing or entitlement error
403
Forbidden
413
File too large
429
Rate or admission limit exceeded
503
Billing unavailable
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
Idempotency-Key
header
string
No
Responses
201
Job created. With `request.execution` set to `auto`, a single document that finishes in time instead returns `200` with the results object.
400
Invalid request, including unknown fields, bad enum values and mutually exclusive options
401
Missing or invalid API key
404
Input or upload not found
409
`IDEMPOTENCY_CONFLICT`: the `Idempotency-Key` was already used with a different request
422
`PAGE_RANGE_INVALID`, `UNSUPPORTED_CAPABILITY` or `UNSUPPORTED_INPUT`
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
Idempotency-Key
header
string
No
Responses
201
Job created. With `request.execution` set to `auto`, a single document that finishes in time instead returns `200` with the results object.
400
Invalid request, including unknown fields, bad enum values and mutually exclusive options
401
Missing or invalid API key
404
Input or upload not found
409
`IDEMPOTENCY_CONFLICT`: the `Idempotency-Key` was already used with a different request
422
`PAGE_RANGE_INVALID`, `UNSUPPORTED_CAPABILITY` or `UNSUPPORTED_INPUT`
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
200
OK
401
Missing or invalid API key
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
Responses
200
OK
404
Job not found
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
format
query
string
No
include
query
string
No
Responses
200
OK
404
Job not found
409
Results requested before the job reached a terminal status
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
Responses
200
OK
404
Job not found
409
Download requested before the job reached a terminal status
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
No parameters.
Responses
200
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
ptu_id
query
['integer', 'null']
No
api-subscription-key
header
string
No
requestBody
body
json
No
Responses
202
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
ptu_id
query
['integer', 'null']
No
api-subscription-key
header
string
No
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
ptu_id
query
['integer', 'null']
No
api-subscription-key
header
string
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
api-subscription-key
header
string
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
ptu_id
query
['integer', 'null']
No
api-subscription-key
header
string
No
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
422
Unprocessable Entity
429
Quota Exceeded
500
Internal Server Error
503
Service Overloaded
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
202
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded / Rate Limited
500
Internal Server Error
503
Service Unavailable
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
requestBody
body
json
No
Responses
200
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded / Rate Limited
500
Internal Server Error
503
Service Unavailable
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
Responses
202
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded / Rate Limited
500
Internal Server Error
503
Service Unavailable
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
Responses
200
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded / Rate Limited
500
Internal Server Error
503
Service Unavailable
Try it out
Convert cURL to programming languages with
cURL Converter
Parameters
Name
In
Type
Required
job_id
path
string
Yes
Responses
200
Successful Response
400
Bad Request
403
Forbidden
429
Quota Exceeded / Rate Limited
500
Internal Server Error
503
Service Unavailable
Try it out
Convert cURL to programming languages with
cURL Converter