Get animate
track the progress of your animation job and access the download URL for your animated video. this endpoint ensures you can monitor your job’s status and collect the finished product once it’s complete.
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
Path Parameters
Response
A unique identifier for the video.
The status of the audio.
The date and time the animation job was created.
The current step of the animation.
A URL which can be used to download the generated video.
A URL which can be used to download the generated audio.
A URL to the original video file. This is the video that was used as input to the animation process.
A URL to a file containing the input transcript.
The voice used for the audio.
The number of credits deducted for the audio.
The webhook URL.
An error message if the video failed to process.