Generate API

Estimate Cost

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
modelenumRequired
name of the model to use for generation.
inputlist of objectsRequired

Normal lipsync requests must include exactly one visual input (video or image) and one audio or text input. Dubbed lipsync requests using dubParams must include exactly one video input and no audio or text input, because Sync extracts the dubbing source audio from that video. Image inputs are only supported with the sync-3 model. When using segments, audio or text inputs can carry unique refId values.

optionsobjectOptional
additional options available for generation.
segmentslist of objectsOptional
segments definition list. When provided, allows defining one or more video segments with different audio inputs for each segment. Each segment specifies a time range and references an audio input by refId.
webhookUrlstringOptional

Webhook URL for generation status updates. When the generation reaches a terminal state, Sync sends a POST request with the generation payload and a Sync-Signature header. Verify the header with the organization webhook secret from GET /v2/organizations/webhook/secret. HTTPS is strongly recommended.

outputFileNamestringOptional
Base filename for the generated output without extension. The .mp4 extension will be added automatically. Only alphanumeric characters, underscores, and hyphens are allowed, up to 255 characters.
dubParamsobjectOptional

Dubbing parameters. When present, audio is extracted from the single video input, dubbed via ElevenLabs into the target language, and then lipsync is run with the dubbed audio. Do not include audio or text inputs with dubParams; requests that send both are rejected.

projectIdstringOptional

Optionally attach this generation to a project (created via POST /v2/projects) so it appears in Studio under that project. Must reference a project in your organization — otherwise the request is rejected with 422.

Response

Generations retrieved successfully
estimatedFrameCountdouble
The estimated frame count for the generation.
estimatedGenerationCostdouble
The estimated cost of the generation in USD.

Errors

401
Unauthorized Error
500
Internal Server Error