Skip to main content
POST

Authorization

string
required
All API endpoints require Bearer Token authenticationGet your API Key:Visit the API Key Management Page to get your API KeyAdd it to the request header:

Request Parameters

string
required
Video generation model nameSupported models:
  • kling-v3-omni - Kling v3 Omni (unified interface)
string
required
Positive text promptSupports referencing images from image_urls using <<<image_N>>> syntax, where N starts from 1.Example: "Make the person in <<<image_1>>> wave at the camera"
If images are provided but the prompt does not contain any <<<image_N>>> reference, the system will automatically prepend <<<image_1>>> to the prompt.
string
Negative prompt used to exclude unwanted content. Maximum length is 2500 characters.
string
default:"std"
Generation modeOptions:
  • std - Standard mode (720P)
  • pro - Professional mode (1080P)
  • 4k - 4K ultra HD mode
Default: std
integer
default:"5"
Default: 5 Video duration (seconds)Range: 3-15 (minimum 3 seconds, maximum 15 seconds)⚠️ Note: Must be a plain number (e.g. 6), do not add quotes, otherwise an error will occur
string
default:"16:9"
Video aspect ratioOptions:
  • 16:9 - Landscape
  • 9:16 - Portrait
  • 1:1 - Square
Default: 16:9
array<url>
Image URL array for image referencingReference corresponding images in the prompt using <<<image_N>>> syntax (N starts from 1)Example: ["https://example.com/photo.jpg"]
  • Image URLs must be publicly accessible without hotlink protection
  • In image-to-video mode, aspect_ratio may be overridden by the actual image ratio
array<object>
Role-based image array, recommended for image-to-video.Each item format: { "url": "...", "role": "..." }
  • first_frame: first frame
  • last_frame: last frame
  • reference: reference image
image_urls and image_with_roles are mutually exclusive. Use only one.
array
Reference video list (URL-based), up to 1 video.Use refer_type to distinguish types:
  • base: video to be edited (default)
  • feature: feature reference video
Use keep_original_sound to control original audio:
  • no: do not keep (default)
  • yes: keep original sound
Request format:
  • video_url cannot be empty, and the video URL must be accessible
  • When refer_type=base:
    • Start/end frames cannot be defined
    • Reference video must be 3-10 seconds
    • Generated video duration follows the uploaded video
  • When refer_type=feature and video_url is not empty:
    • image_urls can only include a first-frame image
  • Video requirements: MP4/MOV only; duration at least 3 seconds; resolution 720px-2160px; frame rate 24-60fps (output is 24fps); size no more than 200MB
boolean
default:"false"
Whether to enable multi-shot mode.
string
Shot split method: customize / intelligence.Required when multi_shot=true.
array<object>
Multi-shot list, each item is { index, prompt, duration }.
  • Minimum 1 shot, maximum 6 shots
  • Each shot duration must be an integer and >= 1
  • Sum of all shot durations must equal top-level duration
  • index must start from 1 and increase continuously
  • Required when multi_shot=true and shot_type=customize
Example:
array<object>
Reference subject list, up to 3 subjects. Supports:
  • Create subjects on the fly with name, description, element_input_urls
Common format:
Notes:
  • For on-the-fly creation, name, description, element_input_urls are required
  • element_input_urls: 2 to 4 images per subject (first as frontal image, others as references)
  • Use @name in prompt, e.g. "@element_dog and @element_cat are playing on the grass"
boolean
Whether to add watermark
boolean
default:"false"
Whether to generate video with audio
This parameter is mutually exclusive with video_list.When video_list has a value, the audio parameter is not needed.

Parameter Constraints and Boundaries

  • image_urls and image_with_roles are mutually exclusive
  • mode=4k is available for kling-v3-omni
  • Last-frame-only input (last_frame without first frame) is invalid
  • Start/end frames and video edit are mutually exclusive: when video_list.refer_type=base (or omitted), start/end frames are not allowed
  • When video_list is present, audio is ignored
  • video_list supports at most 1 video
  • multi_prompt supports up to 6 shots, with index starting from 1 and increasing continuously

Image Reference Syntax

The Omni model uses <<<image_N>>> syntax to reference images in prompts, providing a unified text-to-video/image-to-video experience:
Auto Reference: If image_urls is provided but the prompt does not contain any <<<image_N>>> reference, the system will automatically prepend <<<image_1>>> to the prompt.

Response

integer
Response status code, 200 on success
array
Response data array

Use Cases

Case 1: Text-to-Video (Standard Mode)

Case 2: Image Reference (Single Image)

Case 3: Multiple Image References

Case 4: Image Provided Without Explicit Reference (Auto-added)

The system will automatically prepend <<<image_1>>> to the prompt, equivalent to "<<<image_1>>>The person slowly turns and smiles".

Case 5: Generate Video with Audio

Note: audio is mutually exclusive with video_list. When video_list has a value, the audio parameter is not needed.
Query Task ResultsVideo generation is an async task that returns a task_id upon submission. Use the Get Task Status endpoint to query generation progress and results.