POST
/
animate

introduction

The /animate endpoint transforms your text into audio and syncs it with your video’s lip movements. Input a video, text, and choose a voice ID; the API outputs a video where the audio matches the visual perfectly. Ideal for adding narrations or voiceovers without needing a recording studio, it supports various voices and languages, making your content accessible and engaging.

api features

synchronized audio generation

automatically generate audio that aligns perfectly with your video’s timing, enhancing the viewer’s experience.

high-quality voices

choose from a wide range of natural-sounding voices to find the perfect match for your video content.

customizable integration

tailor the voice and style to suit your project’s needs with adjustable settings and integration options.

available models

explore our diverse range of models, each designed for specific syncing needs. selecting the appropriate model ensures optimal performance and results.

built-in voices

Discover our selection of built-in voices available for the animate api, or create a custom voice by following the guide here.

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.

animate your videos

after you have your x-api-key, animating your videos with custom audio generated from text is straightforward using the /animate endpoint. enhance your educational materials, social media content, or captivating presentations with dynamic audio. follow the detailed steps below to seamlessly integrate speech into your videos.

Authorizations

x-api-key
string
headerrequired

Body

application/json
videoUrl
string
required

A url to the video file to be synchronized -- must be publicly accessible

transcript
string
required

A string of text to be spoken by the AI

voiceId
string
default: e5361405-4967-446d-ad63-2f6ed8729c66required

The voice to use for audio generation

model
string
default: sync-1.6.0

The model to use for video generation

maxCredits
number

Maximum number of credits to use for audio generation. If job exceeds this value, the job will be aborted

webhookUrl
string

A url to send a notification to upon completion of audio generation

Response

201 - 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
string

The current step of the animation.

videoUrl
string

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

audioUrl
string

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
string
required

A URL to a file containing the input transcript.

voiceId
string
required

The voice used for the audio.

creditsDeducted
number
required

The number of credits deducted for the audio.

webhookUrl
string

The webhook URL.

errorMessage
string
required

An error message if the video failed to process.