Sign in
video-generate

Generate a video from a text prompt with Kling v3 Standard

Generate a video from a text prompt with Kling v3 Standard.

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-text-to-video

Request body

promptstring required

A natural-language prompt describing the video to generate.

negative_promptstring

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

aspect_ratio'16x9' | '9x16' | '1x1'

The aspect ratio of the generated video.

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

{
  "duration": 5,
  "shot_type": null,
  "aspect_ratio": null,
  "private": true,
  "webhook_url": "https://api.example.com/webhooks/ideogram",
  "negative_prompt": "negative_prompt",
  "target_collection_id": "target_collection_id",
  "generate_audio": false,
  "prompt": "A red fox running through a snowy forest at dawn.",
  "cfg_scale": 0.5
}

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