Skip to navigation
VideoGenerate

Text to video with Kling v3 Standard

Generate a video from a text prompt with Kling v3 Standard. Returns a generation_id; poll GET /v2/generations/{generation_id} or supply a webhook_url.

Authentication

Api-Keystring

API key for access control. Use in the header with the name "Api-Key"

Query parameters

dry_runbooleanOptionalDefaults to false

When true, the request is validated and priced but not run: nothing is generated, stored, or billed, and no safety review is performed. The response is a PriceQuote object instead of the usual response for this endpoint. Send exactly the request you would send to generate, so the quote reflects the same options.

Request

A request to generate a video from a text prompt with Kling v3 Standard.
promptstringRequired1-2000 characters

A natural-language prompt describing the video to generate.

negative_promptstringOptional<=2000 characters
Description of what to keep out of the video. Descriptions in the prompt take precedence over descriptions in the negative prompt.
aspect_ratioenumOptionalDefaults to 16x9
The aspect ratio of the generated video.
Allowed values:
durationintegerOptional3-15
The length of the generated video in seconds. Defaults to 5 seconds when omitted.
generate_audiobooleanOptionalDefaults to false
Whether to generate an audio track for the video. Audio roughly doubles the provider cost and is subject to stricter output moderation.
shot_typeenumOptionalDefaults to customize

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

Allowed values:
cfg_scalefloatOptional
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_urlstringOptionalformat: "uri"<=2048 characters

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.

Response

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

generation_idstring

The generation ID to poll with GET /v2/generations/{generation_id}.

createddatetime
The time the request was accepted.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error