Endpoints

Create Generation with Files

Headers

x-api-keystringRequired

Request

Use content type multipart/form-data to use local files to create a generation. Only files below 20MB are supported. For larger files, use input field to provide urls for the corresponding input items. Combining both file and url inputs is also supported, with the file taking precedence over the url.

videofileOptional
Input video file.
audiofileOptional
Input audio file.
modelenumRequired
name of the model to use for generation.
Allowed values:
inputlist of objectsOptional

Array of input objects. Can be used to provide urls for larger files. Each input should either have a file or a url. Audio input items can be provided as either: recorded/captured audio url or a text-to-speech input with tts provider configuration.

optionsobjectOptional
webhookUrlstringOptional

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.
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