Create Generation
Authentication
x-api-keystring
API Key authentication via header
Request
This endpoint expects an object.
model
name of the model to use for generation.
Allowed values:
input
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.
options
additional options available for generation.
segments
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.
webhookUrl
webhook url for generation status updates. once the generation completes we will send a POST request to the webhook url with the generation data.
outputFileName
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
createdAt
The date and time the generation was created.
id
A unique identifier for the generation.
input
An array of input objects used for generation.
model
The name of the model used for generation.
Allowed values:
status
The status of the generation.
Allowed values:
error
The error message if the generation failed.
error_code
The error code if the generation failed.
options
Options for the generation.
outputDuration
The duration of the output media.
outputUrl
The URL of the output media.
segments
The segments of the generation.
segmentOutputUrl
The URL of the segment output media.
webhookUrl
The URL to the webhook endpoint.
Errors
400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
