​

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

​

available models

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

sync-1.6.0

sync-1.5.0

wav2lip++

sync-1

sync-1.5.1-beta

​

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:

lipsync your video via the api playground

1

authorize

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

enter your x-api-key in the authorization section

2

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"
}

3

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.