Videos

Generate a video from 1-5 reference images and a text prompt (references-to-video). Unlike createVideo, which animates a single source image, this composes a new scene that borrows characters, objects, and style from the reference images. Each image can be a URL or base64. Griffin (default, 480p) and Griffin HD (720p) generate a soundtrack; note the per-second rate here is higher than createVideo's for the same model. The job result is the video URL and its actual duration in seconds. Choose the output shape with `aspect_ratio` ("default" lets the model decide). The chosen `model` and `duration` must be compatible (incompatible combinations return HTTP 400). Credits are held when the job is accepted; the final charge is max(rate × produced seconds, the model's minimum charge), never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. Pass an optional `request_id` to tag the result so you can locate it later via listGenerations (type video). Related tools: `createVideo` for image-to-video, `editVideo` to modify a generated video. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).

post/assets/video/references

Request body

promptstring required

Text description of the video to generate.

imagesstring[] required

Reference images (1 to 5), each a URL or base64. The generated video borrows characters, objects, and style from them.

durationnumber float

Video length in seconds.

model'griffin' | 'griffin-hd' | 'eagle' | 'eagle-audio'

Video model to use. Griffin (480p) and Griffin HD (720p) are the current models and generate audio; Eagle is legacy.

aspect_ratio'default' | 'ar_1_1' | 'ar_16_9' | 'ar_9_16' | 'ar_4_3' | 'ar_3_4' | 'ar_21_9'

Output aspect ratio. "default" lets the model choose.

request_idstring

Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations.

asyncboolean

Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.

Response

Success

urlstring

URL to the generated video file

durationnumber float

Duration of the video in seconds

has_audioboolean
request_idstring
created_atinteger

Changes

Changed in 1 of the 17 revisions of this API.1