For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Array of input objects. Must include one video input item and at least one audio input item. Audio input items can be provided as either: recorded/captured audio url or a text-to-speech input with tts provider configuration. When using segments, multiple audio inputs can be provided with 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. once the generation completes we will send a POST request to the webhook url with the generation data.
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 video input, dubbed via ElevenLabs into the target language, and then lipsync is run with the dubbed audio. Audio inputs in the input array are ignored when dubbing is enabled — so a single video input (with audio) is sufficient.
