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

introduction

after initiating an animation job, the /animate/{id} endpoint serves as your gateway to updates. use it to monitor the progress of your animation job and access the download URL for your animated video.

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 animation projects

with an x-api-key, tracking the evolution of your animation projects becomes a straightforward task. to track the progress 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 video.

status
string
required

The status of the audio.

createdAt
string
required

The date and time the animation job was created.

step
object

The current step of the animation.

videoUrl
object

A URL which can be used to download the generated video.

audioUrl
object

A URL which can be used to download the generated audio.

originalVideoUrl
string
required

A URL to the original video file. This is the video that was used as input to the animation process.

transcriptUrl
object
required

A URL to a file containing the input transcript.

voiceId
string
required

The voice used for the audio.

creditsDeducted
object
required

The number of credits deducted for the audio.

webhookUrl
object

The webhook URL.

errorMessage
object
required

An error message if the video failed to process.