Skip to main content
POST
Kling Omni Image Task

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer <token> in the request header.

Headers

Content-Type
string
default:application/json
required

Data exchange format

Body

application/json
model_name
enum<string>
required

Model name

Available options:
kling-v3-omni
prompt
string
required

Text prompt, can include positive and negative descriptions

  • Prompts can be templated to meet different image generation needs
  • Must not exceed 2500 characters
  • Use <<<>>> format to specify an image, e.g.: <<<image_1>>>
Maximum string length: 2500
image_list
object[]

Reference image list. Use key:value format:

  • Supports image Base64 encoding or image URL (must be accessible)
  • Supported image formats: .jpg / .jpeg / .png
  • Image file size must not exceed 10MB, image dimensions must be at least 300px, aspect ratio between 1:2.5 ~ 2.5:1
  • The total number of reference elements and reference images must not exceed 10
  • image_url parameter value must not be empty
Maximum array length: 10
element_list
object[]

Element reference list, configured based on element IDs in the element library

  • Use key:value format: "element_list":[{ "element_id": 829836802793406551 }]

  • The total number of reference elements and reference images must not exceed 10

Maximum array length: 10
resolution
enum<string>
default:1k

Generated image resolution

Available options:
1k,
2k,
4k
result_type
enum<string>
default:single

Switch between single image / series image result

Available options:
single,
series
aspect_ratio
enum<string>
default:auto

Aspect ratio of generated images (width:height)

Enum values: 16:9 9:16 1:1 4:3 3:4 3:2 2:3 21:9 auto

  • auto: intelligently generates aspect ratio based on input content
Available options:
16:9,
9:16,
1:1,
4:3,
3:4,
3:2,
2:3,
21:9,
auto
n
integer
default:1

Number of images to generate

  • Range: [1, 9]
  • When result_type is series, this parameter is ignored
Required range: 1 <= x <= 9
series_amount
default:auto

Number of images in the series

Enum values: 2 3 4 5 6 7 8 9 auto

  • auto: intelligently selects the number of images based on input content
  • When using auto, it consumes concurrency quota corresponding to the actual number generated
  • When result_type is single, this parameter is ignored
Available options:
2,
3,
4,
5,
6,
7,
8,
9,
auto
Required range: 2 <= x <= 9
watermark_info
object

Whether to also generate a watermarked result.

callback_url
string

Callback notification URL for this task. If configured, the server will proactively notify when the task status changes.

external_task_id
string

Custom task ID

  • User-defined task ID; does not override the system-generated task ID, but supports querying by this ID
  • Must be unique per user

Response

200 - application/json

Task accepted.

code
integer

Error code; see error codes for details.

Example:

0

message
string

Error message.

Example:

"string"

request_id
string

Request ID, system-generated, used for request tracking and troubleshooting.

Example:

"string"

data
object