Generate API

Create Generation

Headers

x-api-keystringRequired

Request

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

Array of input objects. Must include one video input item and 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.

optionsobjectOptional
additional options available for generation.
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.

Response

Job created successfully
createdAtdatetime
The date and time the generation was created.
idstring
A unique identifier for the generation.
inputlist of objects
An array of input objects used for generation.
modelenum
The name of the model used for generation.
Allowed values:
statusenum
The status of the generation.
Allowed values:
errorstring or null
The error message if the generation failed.
error_codestring or null
The error code if the generation failed.
optionsobject or null
Options for the generation.
outputDurationdouble or null
The duration of the output media.
outputUrlstring or null
The URL of the output media.
segmentOutputUrlstring or null
The URL of the segment output media.
webhookUrlstring or null
The URL to the webhook endpoint.

Errors