GET
/
voices
/
{id}
curl --request GET \
  --url https://api.synclabs.so/voices/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "createdAt": "<string>",
  "status": {},
  "name": {},
  "description": {},
  "inputSamples": [
    "<string>"
  ],
  "outputSamples": [
    "<string>"
  ],
  "creditsDeducted": {},
  "webhookUrl": {},
  "errorMessage": {}
}

introduction

after initiating a voice synthesis job, use the /voices/{id} endpoint to stay updated on its progress and to retrieve the synthesized audio.

this guide helps you navigate the tracking process, ensuring you’re always informed about your job’s progress.

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.

monitor your voice synthesis jobs

with an x-api-key, following the progress of your voice synthesis is easy. to check your job’s status via the playground above, follow these instructions:

Authorizations

x-api-key
string
headerrequired

Path Parameters

id
string
required

Response

200 - application/json
id
string
required

A unique identifier for the voice.

createdAt
string
required

The date and time the voice was created.

status
object
required

The status of the voice.

name
object

A name for the voice.

description
object

A description the voice.

inputSamples
string[]
required

Input samples for creating the voice.

outputSamples
string[]
required

Output samples for hearing the voice.

creditsDeducted
object
required

The cost of the voice.

webhookUrl
object
required

The webhook URL for the voice.

errorMessage
object
required

An error message if the voice failed to process.