Skip to navigation
Text-to-Speech API

Get Text-to-Speech Job

Retrieve a text-to-speech job by id. While the job is PENDING or PROCESSING, the response carries a Retry-After: 3 header. The header is absent once the job reaches a terminal state (SUCCESS or FAILED).

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
The job id returned when the job was submitted.

Response

Job retrieved successfully
idstring
Unique identifier for the job.
statusenum
The current lifecycle status of the job.
Allowed values:
createdAtdatetime
When the job was created.
urlstringOptional
The hosted URL of the synthesized audio. Null unless status is SUCCESS.
durationdoubleOptional
Duration of the synthesized audio in seconds. Null unless status is SUCCESS.
errorobjectOptional
Error detail. Null unless status is FAILED.
startedAtdatetimeOptional
When synthesis started. Null until synthesis starts.
finishedAtdatetimeOptional
When the job reached a terminal state. Null until the job is SUCCESS or FAILED.

Errors

401
Unauthorized Error
404
Not Found Error