Generate API

List Generations

Authentication

x-api-keystring
API Key authentication via header

Query parameters

statuslist of enumsOptional

Filter generations by status. Accepts multiple statuses as a comma-separated list.

Allowed values:
idslist of stringsOptional

Filter generations by ID. Accepts multiple IDs as a comma-separated list.

sourcelist of stringsOptional

Filter generations by source. Accepts multiple sources as a comma-separated list.

Response

Generations retrieved 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.
statusenum
The status of the generation.
errorstringOptional
The error message if the generation failed.
errorCodestringOptional

Stable, machine-readable error code if the generation failed (e.g. generation_input_video_inaccessible). The full catalog of codes, messages and suggested fixes is served unauthenticated at GET /v2/errors.

optionsobjectOptional
Options for the generation.
outputDurationdoubleOptional
The duration of the output media.
outputUrlstringOptional
The URL of the output media.
outputFileNamestringOptional
The sanitized filename applied to the output media. Characters outside letters, numbers, dashes and underscores are stripped and spaces become underscores, so this can differ from the value submitted. Null when no name was provided.
segmentslist of objectsOptional
The segments of the generation.
segmentOutputUrlstringOptional
The URL of the segment output media.
synthesizedAudioUrlstringOptional

The URL of the audio synthesized from a text (TTS) input. Only present for generations created with a TTS text input; reuse it as an audio input to keep the same take across generations.

webhookUrlstringOptional
The URL to the webhook endpoint.
projectIdstringOptional
The id of the project this generation is attached to, or null when it belongs to no project. Set via the projectId field on the create request.

Errors

401
Unauthorized Error
500
Internal Server Error