quickstart

​

getting started with sync.

welcome to the sync. quickstart guide! here, we’ll guide you through creating an account in our web app, generating your first api key, and making your initial request using the /lipsync endpoint.

the /lipsync endpoint allows you to synchronize your videos’ lip movements with any audio track, enhancing accessibility, engagement, and overall video quality. follow the steps below to seamlessly integrate cutting-edge lip-sync technology into your projects.

​

create an account in the web app

to kickstart your journey with our apis, the first step is to create an account on our web app. this simple process allows you to obtain an api key, manage your account, and access our apis.

​

generate an api-key

after signing up a new api key is automatically generated for you and can be accessed from the keys page of the web app.

you can also create new api keys and manage existing ones at any time from the same page.

access the keys page in the web app

from the web app, you can view, create, and manage your api keys by navigating to the keys page. here

1

open the profile drop down menu

2

click on api keys

create a new key

you can create a new API key at any time by clicking the Create Key + button.

revoke an existing key

you can revoke an API key at any time by clicking on the Revoke button next to the API Key you want to revoke.

this will immediately revoke the API key and any requests using that API key will fail.

1

step 1

2

step 2

​

generate your first video using the api

once you have your x-api-key, you’re ready to synchronize your first video using the /lipsync endpoint. to sync your video via the playground 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

​

checkout one of our other apis

dive into our comprehensive API offerings across various endpoint families designed to enhance your video and audio projects. each family serves a unique purpose, empowering your applications with advanced synchronization, voice generation, and animation capabilities.