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.

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:
errorstringOptional

The error message if the generation failed.

optionsobjectOptional

Options for the generation.

outputDurationdoubleOptional

The duration of the output media.

outputUrlstringOptional

The URL of the output media.

webhookUrlstringOptional

The URL to the webhook endpoint.

Errors