POST

lipsync

introduction

sync. brings video content to life with unmatched lip-syncing technology. experience the magic of our /lipsync endpoint, capable of aligning video lip movements with any audio seamlessly.

leverage our lip-sync API to transform videos in real-time, making content more engaging and accessible. perfect for dubbing, content localization, or just adding a fun twist to your videos. Dive into our documentation to start using the API in various development environments.

api features

precise synchronization

achieve perfect lip-syncing with advanced AI, enhancing viewer engagement.

rapid processing

enjoy fast video processing speeds without compromising on output quality.

flexible integration

easy integration into your existing workflows with comprehensive developer support.

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.

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.

lipsync your videos

once you have your x-api-key, you’re ready to start syncing your videos’ lip movements with any audio track. to sync your video via the playground above follow the instructions below:

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

{
  "audioUrl": "https://example.com/audio.mp3",
  "videoUrl": "https://example.com/video.mp4",
  "synergize": true,
  "model": "sync-1.6.0"
}

submit

click the Send button to submit your synchronization request. after submission, you will receive a response that includes the id of your lip-sync 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": "processing",
  "videoUrl": "",
  "originalVideoUrl": "https://example.com/video.mp4",
  "originalAudioUrl": "https://example.com/audio.mp3",
  "synergize": true,
  "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 /lipsync/{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 /lipsync/{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 lipsync api playground

with these methods, you can easily add lipsync functionality to your video editing, content creation, or localization workflows, enhancing the viewing experience for your audience.

Authorizations

x-api-key

string

headerrequired

Body

application/json

audioUrl

string

required

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

videoUrl

string

required

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

maxCredits

number

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

model

string

default: sync-1.6.0

The model to use for video generation

synergize

boolean

default: true

enable, disable restoration stage | highly recommended to keep on

pads

string[]

[top, bottom, left, right], number of pixels to add as padding

synergizerStrength

number

1 is very good quality but identity features will reduce, 0 is very natural / identity will be preserved but less clean up of artifacts

webhookUrl

string

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

Response

201 - application/json

string

required

A unique identifier for the video.

createdAt

string

required

The date and time the video was created.

status

string

required

The status of the video.

videoUrl

string

required

A URL which can be used to download the video.

originalVideoUrl

string

required

The original URL of the video that was submitted.

originalAudioUrl

string

required

The original URL of the audio that was submitted.

synergize

boolean

required

A flag to enable / disable post-processing

creditsDeducted

number

required

The number of credits deducted for the video.

webhookUrl

string

required

The URL to the webhook endpoint.

errorMessage

string

required

An error message if the video failed to process.

Get lipsync cost Get animate

api documentation

lipsync

animate

speak

voices

Post lipsync

introduction

api features

precise synchronization

rapid processing

flexible integration

available models

quick start

authentication

lipsync your videos

example input

understanding the response

polling for completion

Authorizations

Body

Response

api documentation

lipsync

animate

speak

voices

​introduction

​api features

precise synchronization

rapid processing

flexible integration

​available models

​quick start

​authentication

​lipsync your videos

example input

understanding the response

polling for completion

Authorizations

Body

Response

introduction

api features

available models

quick start

authentication

lipsync your videos