GET
/
speak
/
{id}
curl --request GET \
  --url https://api.synclabs.so/speak/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "createdAt": "<string>",
  "status": "<string>",
  "step": {},
  "audioUrl": {},
  "transcriptUrl": {},
  "voiceId": "<string>",
  "creditsDeducted": {},
  "webhookUrl": {},
  "errorMessage": {}
}

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

x-api-key
string
headerrequired

Path Parameters

id
string
required

Response

200 - application/json
id
string
required

A unique identifier for the audio.

createdAt
string
required

The date and time the audio was created.

status
string
required

The status of the audio.

step
object

The step of the audio.

audioUrl
object

A URL which can be used to download the audio.

transcriptUrl
object
required

A URL to a file containing the input transcript.

voiceId
string
required

The voice ID used for the audio.

creditsDeducted
object
required

The number of credits deducted for the audio.

webhookUrl
object

The webhook URL to notify the user when the audio is ready.

errorMessage
object
required

An error message if the audio failed to process.