​

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:

via the api playground

1

retrieve your job id

following your submission via the /speak endpoint, a job id will be provided. this id is essential for subsequent tracking activities.

example response from the post /speak endpoint

2

monitor job status

periodically querying the /speak/{id} endpoint with your job id will keep you updated on the synthesis process. this ensures you remain informed about the progress of your speech synthesis job.

insert your job id to check its status.

3

access your generated audio

upon reaching a completed status, the endpoint’s response will include a URL to download your generated audio. this audio.

the response will provide a `url` for downloading your audio.