Sign in
video-generate

Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes

Generate a video from a first-frame image and a text prompt with Kling v3 Standard. Supply the first frame either as an image_asset_identifier reference (an image already stored with Ideogram) or as raw image bytes (multipart requests only) — callers are never required to upload the asset first. Exactly one source is required; supplying neither or both is rejected. Only image assets are accepted as a first frame. Uploaded bytes are used for this request only and are not stored as an asset.

To generate a transition between two stills, supply a final frame as well, in either of the same two forms: end_image_asset_identifier or end_image. The final frame is optional and follows the same one-form-only rule.

The generated video takes its aspect ratio from the first frame, so there is no aspect ratio to set.

Video generation always runs asynchronously: the response returns as soon as the request is accepted and carries only a generation_id. Poll for completion and results with GET /v1/generations/{generation_id} using that id, or supply a webhook_url to have the finished result POSTed to your server instead.

Video links are available for a limited period of time; download the video if you want to keep it.

post/v2/video/generate/kling-v3-standard-image-to-video

Request body

imagestring binary

The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset.

end_imagestring binary

An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset.

promptstring required

A natural-language prompt describing how the first frame should animate.

negative_promptstring

Description of what to keep out of the video. Descriptions in the prompt take precedence over descriptions in the negative prompt.

durationinteger

The length of the generated video in seconds. Defaults to 5 seconds when omitted.

generate_audioboolean

Whether to generate an audio track for the video. Audio roughly doubles the provider cost and is subject to stricter output moderation.

shot_type'customize' | 'intelligent'

How the prompt is staged. customize follows the prompt as written; intelligent lets the model break the prompt into its own shots.

cfg_scalenumber float

How closely the video follows the prompt, from 0 to 1. Lower values leave the model more freedom. Defaults to 0.5 when omitted.

webhook_urlstring uri

HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a JSON POST to this URL once all images for the request have finished generating. The body mirrors the synchronous generate response: request_id, created, and a data array containing every generated image (url, prompt, resolution, seed, is_image_safe). Each delivery is signed with Ed25519 and verifiable against the public keys at https://api.ideogram.ai/v1/.well-known/jwks.json. Must be HTTPS; private and loopback hosts and the cloud metadata service are rejected.

privateboolean nullable

When true or omitted, the output is kept private to your account. Set to false to publish the output to the public feed. Enterprise accounts always generate privately.

target_collection_idstring

A collection you can write to, by its URL-safe base64 collection id. The output videos are added to it when the request completes.

Example request

{
  "image_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "end_image_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "prompt": "The camera slowly pans right as the waves roll in.",
  "duration": 5,
  "cfg_scale": 0.5,
  "webhook_url": "https://api.example.com/webhooks/ideogram"
}

Response

An acknowledgement to poll with GET /v1/generations/{generation_id}.

generation_idstring required

URL-safe base64 ID of the accepted generation. Accepted by the GET /v1/generations/{generation_id} polling endpoint.

createdstring date-time required

The time the request was accepted.

Example response

{
  "generation_id": "generation_id",
  "created": "2000-01-23T04:56:07+00:00"
}

Changes