Sign in
Videos

Generate a short video clip from a source image and a motion text prompt (image-to-video). Synchronous until September 10, 2026: the call blocks until rendering finishes and returns the video URL and its actual duration in seconds - there is no separate polling step. Optionally pass `final_image` to interpolate between a start and end frame. The chosen `model` and `duration` must be compatible (incompatible combinations return HTTP 400); see the `model` and `duration` fields for the values each model accepts. Credits are charged only on success, based on the produced duration and never more than the duration you requested. Pass an optional `request_id` to tag the result so you can locate it later via `GET /assets/videos/results`. Related tools: use `createImage` for static images, `animateSprite` for sprite-sheet animation, and `GET /assets/videos/results` to list videos you generated earlier. Requires an API key (user scope). Async is the intended integration pattern: pass `async: true` and the call returns 202 with a job id - poll `GET /assets/jobs/{id}` (`getApiJob` in MCP), honouring poll_after_ms or long-polling with wait=30, until status is succeeded, whose result field is exactly the response documented for this operation. Synchronous responses are deprecated: they remain the default until September 10, 2026, after which requests default to async and return 202 with a job id; set `async: false` explicitly to keep synchronous behavior during and after the transition. 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

Request body

imagestring required

URL or base64-encoded source image (the starting frame for the video)

promptstring required

Text description of the motion or action for the video (e.g., "walking forward", "waving hand", "camera zoom in")

augment_promptboolean

Augment the prompt behind the scenes. Disable to have more control.

final_imagestring

URL or base64-encoded end frame image. When provided, the video will interpolate between the initial and final frames.

durationnumber float

Video duration in seconds. Available values depend on the model - the source of truth is MODEL_PRICING (credits.js), surfaced via /credits/costs; the public API docs list them per model (auto-generated).

model'blitz' | 'eagle' | 'eagle-audio' | 'standard' | 'forge-pixel'

Video generation model to use. forge-pixel renders pixel-art video.

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 with the results endpoint.

asyncboolean

When true, return 202 immediately with a job id instead of waiting for the result. Poll GET /assets/jobs/{id}. Defaults to false (synchronous).

Example request

{
  "image": "<url> OR data:image/png;base64,...",
  "final_image": "<url> OR data:image/png;base64,...",
  "duration": 3,
  "model": "blitz"
}

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 8 revisions of this API.1