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.

model id:

sync-1.6.0

description: our best mode, everything good about sync-1.5 but now with fluid, human-like mouth movements. When to switch to 1.5: (i) you want the mouth movements to be more visibly prominent, (ii) you observe visual artifacts at the scene boundaries.

when to use: opt for this model to address nuances in teeth visibility and mouth coloration for a flawless finish.

model id:

sync-1.5.0

description: accurate, high-resolution lipsync that has been proven to be reliable over a large variety of videos. Why choose this: if sync-1.6 model gives you feeble-looking lip movements, this version can perform better.

why choose: perfect when upgrading from earlier versions or seeking a stable, tested option when the latest beta model doesn’t fit your project needs.

model id:

wav2lip++

description: low-resolution, fast, lipsync that will be free forever. Not suitable for commercial use.

why choose: use this for fast processing of low-resolution videos or for testing purposes.

model ids:

sync-1

sync-1.5.1-beta

description: offering compatibility for projects initiated on older standards, this model ensures continuity. automatically upgrades to sync-1.5.0 for enhanced outcomes.

legacy advantage: use this for ongoing projects needing legacy support with the benefit of automatic quality improvements.

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.

authorize

enter your api key in the x-api-key field within the Authorization section.

enter your x-api-key in the authorization section

enter params

enter the params in the body section:

enter the urls for your publicly accessible audio and video files into the respective fields and set other required parameters.

example input

{
  "videoUrl": "https://example.com/video.mp4",
  "transcript": "hello, welcome to our video", 
  "voiceId": "e5361405-4967-446d-ad63-2f6ed8729c66", # default male voice
  "model": "sync-1.6.0"
}

submit

click the Send button to submit your animation request. after submission, you will receive a response that includes the id of your animation job, the current status, and URLs to the original submissions.

understanding the response

the initial response provides you with essential details to track your job:

{
  "id": "unique_job_id",
  "createdAt": "date_time",
  "status": "PENDING",
  "step": null,
  "videoUrl": null,
  "audioUrl": null,
  "originalVideoUrl": "https://example.com/video.mp4",
  "transcriptUrl": "https://example.com/transcript.txt",
  "voiceId": "e5361405-4967-446d-ad63-2f6ed8729c66",
  "creditsDeducted": 123,
  "webhookUrl": null,
  "errorMessage": null
}

your job’s status will start as pending and move to processing. use the returned id with the GET /animate/{id} endpoint to periodically poll for the status of your job. this polling is crucial for knowing when your video is ready.

polling for completion

periodically send requests to GET /animate/{id} with your job id. when the job status changes to completed, the response will include a URL to download your synced video.

Click here to view instructions on polling for job completion with the get animate api playground

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

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.

api documentation

lipsync

animate

speak

voices

Post animate

introduction

api features

synchronized audio generation

high-quality voices

customizable integration

available models

built-in voices

quick start

authentication

animate your videos

example input

understanding the response

polling for completion

Authorizations

Body

Response

api documentation

lipsync

animate

speak

voices

​introduction

​api features

synchronized audio generation

high-quality voices

customizable integration

​available models

​built-in voices

​quick start

​authentication

​animate your videos

example input

understanding the response

polling for completion

Authorizations

Body

Response

introduction

api features

available models

built-in voices

quick start

authentication

animate your videos