v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB
Lipsync

Create Lipsync

Replaces the audio on an existing video and re-animates the speaker's lip movements to match the new audio. Use mode: 'speed' for fast output or 'precision' for high-quality lip-sync.

post/v3/lipsyncs

Headers

Idempotency-Keystring

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Request body

titlestring nullable

Title for the lipsync job

mode'speed' | 'precision'
callback_urlstring nullable

Webhook URL for completion notifications

callback_idstring nullable

ID included in webhook payload

enable_captionboolean

Generate captions for the output video

keep_the_same_formatboolean nullable

Preserve the source video's encoding specs (resolution, bitrate).

enable_dynamic_durationboolean

Allow dynamic duration adjustment

disable_music_trackboolean

Remove background music

enable_speech_enhancementboolean

Enhance speech quality

enable_watermarkboolean

Add watermark to output

start_timenumber nullable

Start time in seconds for partial lipsync

end_timenumber nullable

End time in seconds for partial lipsync

fps_modestring nullable

Frame rate mode: 'vfr', 'cfr', or 'passthrough'.

folder_idstring nullable

Project/folder ID to organize lipsync into

Response

Successful response