Generate API

Estimate Cost

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

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

Errors