v3

latestOpenAPI 3.1.02026-07-313340106.6 KB
Generate

get/v2/generations

Query parameters

statusstring

Filter generations by status

limitnumber

Maximum number of generations to return (1-100). When set, results are ordered newest-first and can be paged with cursor.

cursorstring

Generation id to page after - pass the last id of the previous page. Only used together with limit.

Response

Generations retrieved successfully

idstring required

A unique identifier for the generation.

createdAtstring date-time required

The date and time the generation was created.

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'REJECTED' required

The status of the generation.

modelstring required

The name of the model used for generation.

projectIdstring nullable

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.

segmentsobject[] required

The segments definition for the generation.

webhookUrlstring nullable

The URL to the webhook endpoint.

optionsobject

Options for the generation.

outputUrlstring nullable

The URL of the output media.

outputDurationnumber nullable

The duration of the output media.

segmentOutputUrlstring nullable

The URL of the segment output media.

outputFileNamestring nullable

The sanitized filename applied to the output media. Non-alphanumeric characters (except dashes and underscores) are stripped and spaces become underscores, so the value here is the canonical name used for the downloaded file - it may differ from what was submitted. Null when no name was provided.

synthesizedAudioUrlstring

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

errorstring

The error message if the generation failed.

errorCodestring nullable

Stable machine-readable error code if the generation failed. The full catalog with messages and suggested fixes is served at GET /v2/errors.

progress_percentnumber

The progress percentage of the generation (0-100). Only included when include=progress.

Example response

[
  {
    "errorCode": "generation_input_video_inaccessible"
  }
]