POST
/
lipsync
curl --request POST \
  --url https://api.synclabs.so/lipsync \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "audioUrl": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortaud-27623a4f-edab-4c6a-8383-871b18961a4a.wav",
  "videoUrl": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortvid-03a10044-7741-4cfc-816a-5bccd392d1ee.mp4",
  "maxCredits": 123,
  "model": "sync-1.6.0",
  "synergize": true,
  "pads": [
    0,
    5,
    0,
    0
  ],
  "synergizerStrength": 1,
  "webhookUrl": "<string>"
}'
{
  "id": "<string>",
  "createdAt": "<string>",
  "status": "<string>",
  "videoUrl": {},
  "originalVideoUrl": "<string>",
  "originalAudioUrl": "<string>",
  "synergize": true,
  "creditsDeducted": {},
  "webhookUrl": {},
  "errorMessage": {},
  "url": {},
  "original_video_url": "<string>",
  "original_audio_url": "<string>",
  "credits_deducted": {},
  "message": "<string>"
}

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.

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:

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
id
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
object
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
object
required

The number of credits deducted for the video.

webhookUrl
object
required

The URL to the webhook endpoint.

errorMessage
object
required

An error message if the video failed to process.

url
object
required

DEPRECATED - now use videoUrl - A URL which can be used to download the video.

original_video_url
string
required

DEPRECATED - now use originalVideoUrl - The original URL of the video that was submitted.

original_audio_url
string
required

DEPRECATED - now use originalAudioUrl - The original URL of the audio that was submitted.

credits_deducted
object
required

DEPRECATED - now use creditsDeducted - The number of credits deducted for the video.

message
string
required

An important message related to the API response.