Retrieves the current status of a Text-to-Speech task using the specified task_id
.
GET
request to this endpoint with the task_id
you received when you submitted your original request. The system will respond with detailed information about where your task stands in the processing pipeline.
run_id
needed to download your finished audio file.Status | Description | Next Step |
---|---|---|
SUCCESS | Your audio generation has completed successfully | Use the run_id to download your finished audio |
PENDING | Your task is currently being processed by our system. | Continue polling until completion. |
TIMEOUT | The processing time exceeded the allowed limit. | Consider breaking text into smaller segments. |
ERROR | Something went wrong during processing. | Check error details and try submitting again. |
PAYMENT_REQUIRED | Your account requires additional credits for this operation. | Add credits to your account or upgrade your plan by heading to the billing page and retry the request. |
SUCCESS
, you’ll receive a run_id
in the response. This run_id
is your key to accessing the generated audio. Take this identifier and use it with the /tts-result/{run_id}
endpoint to download your finished audio file and put it to work in your application.The x-api-key
is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.
This parameter represents a unique identifier for a task. It is used in various API endpoints to query the status or result of a specific task. The task_id
is typically returned when a task is created.
Successful Response
The response is of type object
.