Get speak
track the progress of your speech synthesis job and retrieve the download URL for your generated audio. this endpoint allows you to monitor your job’s status and access the output once it’s ready.
introduction
after you’ve submitted your text for speech synthesis using the /speak
endpoint, the /speak/{id}
endpoint is your resource for tracking the job’s progress and obtaining your generated audio.
quick start
authentication
before you can start using our api, you need to authenticate your requests. this is done using an x-api-key
that links your requests to your account. if you don’t have an api key yet, check out the instructions here to obtain one.
track your speech synthesis jobs
with your x-api-key
, you’re set to track the advancement of your speech synthesis tasks. to track your job via the playground above follow the instructions below:
Authorizations
Path Parameters
Response
A unique identifier for the audio.
The date and time the audio was created.
The status of the audio.
A URL to a file containing the input transcript.
The voice ID used for the audio.
The number of credits deducted for the audio.
An error message if the audio failed to process.
The step of the audio.
A URL which can be used to download the audio.
The webhook URL to notify the user when the audio is ready.