Sign in
latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-22360489.7 KB

d03d90b0b8e0

Video Projects

Lip Sync

What this API does

Create the same Lip Sync you can make in the browser, but programmatically, so you can automate it, run it at scale, or connect it to your own app or workflow.

Good for

  • Automation and batch processing
  • Adding lip sync into apps, pipelines, or tools

How it works (3 steps)

  1. Upload your inputs (video, image, or audio) with Generate Upload URLs and copy the file_path.
  2. Send a request to create a lip sync job with the basic fields.
  3. Check the job status until it's complete, then download the result from downloads.

Key options

  • Inputs: see the request schema for endpoint-specific assets
  • Resolution: free users default to 480p; higher plans unlock HD and larger sizes
  • Extra fields: see the request schema for endpoint-specific options

Cost
Credits are only charged for the frames that actually render. You'll see an estimate when the job is queued, and the final total after it's done.

For detailed examples, see the product page.

post/v1/lip-sync

Request body

namestring

Give your video a custom name for easy identification.

start_secondsnumber float required

Start time of your clip (seconds). Must be ≥ 0.

end_secondsnumber float required

End time of your clip (seconds). Must be greater than start_seconds.

max_fps_limitnumber

Defines the maximum FPS (frames per second) for the output video. If the input video's FPS is lower than this limit, the output video will retain the input FPS. This is useful for reducing unnecessary frame usage in scenarios where high FPS is not required.

Example request

{
  "name": "My Lip Sync video",
  "end_seconds": 15,
  "max_fps_limit": 12,
  "assets": {
    "audio_file_path": "api-assets/id/1234.mp3",
    "video_source": "file",
    "video_file_path": "api-assets/id/1234.mp4"
  },
  "style": {
    "generation_mode": "lite"
  }
}

Response

Success

idstring required

Unique ID of the video. Use it with the Get video Project API to fetch status and downloads.

credits_chargedinteger required

The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video.

If video generation fails, credits will be refunded, and this field will be updated to include the refund.

Example response

{
  "id": "cuid-example",
  "credits_charged": 450
}