Ir para a navegação
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).

Autenticação

x-api-keystring
Autenticação de chave de API via cabeçalho

Parâmetros de caminho

idstringObrigatório
The job id returned when the job was submitted.

Resposta

Job retrieved successfully
idstring
Unique identifier for the job.
statusenum
The current lifecycle status of the job.
Valores permitidos:
createdAtdatetime
When the job was created.
urlstringOpcional
The hosted URL of the synthesized audio. Null unless status is SUCCESS.
durationdoubleOpcional
Duration of the synthesized audio in seconds. Null unless status is SUCCESS.
errorobjectOpcional
Error detail. Null unless status is FAILED.
startedAtdatetimeOpcional
When synthesis started. Null until synthesis starts.
finishedAtdatetimeOpcional
When the job reached a terminal state. Null until the job is SUCCESS or FAILED.

Erros

401
Unauthorized Error
404
Not Found Error