Skip to content
中文

Omni-Video

Method: POSTEndpoint: /kling/v1/videos/omni-video

This document is not updated in real time. For the full version, see the official documentation: https://docs.qingque.cn/d/home/eZQCRUy_LWt70n5Wz2sTiLV6J?identityId=1oEFzU43FYK#section=h.hhdxwtuxzvyf

This section contains endpoint-specific behavior, parameters, or usage notes for this API. This section contains endpoint-specific behavior, parameters, or usage notes for this API. This section contains endpoint-specific behavior, parameters, or usage notes for this API. This section contains endpoint-specific behavior, parameters, or usage notes for this API. This section contains endpoint-specific behavior, parameters, or usage notes for this API. This section contains endpoint-specific behavior, parameters, or usage notes for this API.

Request Parameters

Header Parameters

text
Authorization
string
Optional
Default Value:
Bearer {{YOUR_API_KEY}}

Body Parameters application/json

text
model_name
string
Required
kling-video-o1
prompt
string
Required
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
<= 5000 characters
aspect_ratio
string
Required
  // provider-specific example normalized for English documentation
● Enum Values:16:9, 9:16, 1:1
  // provider-specific example normalized for English documentation
image_list
array
[string]
Optional
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
"image_list":[
{
"image_url":"image_url",
"type":"first_frame"
},
{
"image_url":"image_url",
"type":"end_frame"
}
]
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
element_list
array
[string]
Optional
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
"element_list":[
{
"element_id":long
}
]
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
video_list
array
[string]
Optional
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
"video_list":[
{
"video_url":"video_url",
"refer_type":"base",
"keep_original_sound":"yes"
}
]
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
mode
enum<string>
Optional
  // provider-specific example normalized for English documentation
● Enum Values:pro
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
Enum Values:
std (high performance)
pro (high quality)
duration
enum<string>
Optional
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
  // provider-specific example normalized for English documentation
Enum Values:
5
10
callback_url
string
Optional
Callback URL for the task result notification. Optional.
Example
{
"model_name"
:
"string"
,
"prompt"
:
"string"
,
"aspect_ratio"
:
"string"
,
"image_list"
:
[
"string"
]
,
"element_list"
:
[
"string"
]
,
"video_list"
:
[
"string"
]
,
"mode"
:
"std (high performance)"
,
"duration"
:
"5"
,
"callback_url"
:
"string"
}

Example Request

Shell

bash
curl --location --request POST '/kling/v1/videos/omni-video' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model_name": "string",
    "prompt": "string",
    "aspect_ratio": "string",
    "image_list": [
        "string"
    ],
    "element_list": [
        "string"
    ],
    "video_list": [
        "string"
    ],
    "mode": "std (high performance)",
    "duration": "5",
    "callback_url": "string"
}'

Response

🟢 200 Success

Content Type: application/json

Response Schema

text
code
integer
Required
Error code. See the error-code definitions for details.
message
string
Error Message
Required
request_id
string
Required
Request ID, generated by the system for tracking and troubleshooting.
data
object
Required
task_id
string
Task ID, generated by the system.
Required
task_status
enum<string>
Required
Task status. Enum values: submitted, processing, succeed, failed.
Enum Values:
submitted (submitted)
processing (in progress)
succeed (success)
failed (failure)
created_at
integer
Required
Task creation time, Unix timestamp in milliseconds.
updated_at
integer
Required
Task update time, Unix timestamp in milliseconds.

Example

json
{
    "code": 0,
    "message": "string",
    "request_id": "string",
    "data": {
        "task_id": "string",
        "task_status": "string",
        "created_at": 0,
        "updated_at": 0
    }
}