GET
/
lipsync
/
{id}
curl --request GET \
  --url https://api.synclabs.so/lipsync/{id} \
  --header 'x-api-key: <api-key>'
{
  "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

after submitting your video and audio for synchronization, use the /lipsync/{id} endpoint to monitor progress and retrieve your video.

stay updated on your job’s status and get the final, generated video.

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.

track your lipsync videos

once you have your x-api-key, you’re ready to start tracking the progress of your lipsync videos. to track your video via the playground above follow the instructions below:

Authorizations

x-api-key
string
headerrequired

Path Parameters

id
string
required

Response

200 - 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.