Passer à la 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).

Authentification

x-api-keystring
Authentification par clé API via en-tête

Paramètres de chemin

idstringRequis
The job id returned when the job was submitted.

Réponse

Job retrieved successfully
idstring
Unique identifier for the job.
statusenum
The current lifecycle status of the job.
Valeurs autorisées:
createdAtdatetime
When the job was created.
urlstringOptionnel
The hosted URL of the synthesized audio. Null unless status is SUCCESS.
durationdoubleOptionnel
Duration of the synthesized audio in seconds. Null unless status is SUCCESS.
errorobjectOptionnel
Error detail. Null unless status is FAILED.
startedAtdatetimeOptionnel
When synthesis started. Null until synthesis starts.
finishedAtdatetimeOptionnel
When the job reached a terminal state. Null until the job is SUCCESS or FAILED.

Erreurs

401
Unauthorized Error
404
Not Found Error