Doc version: v1.0.0 | Last updated: 2026-06-11 This platform fully supports the Kling AI official video generation API. Requests and responses are transparently proxied; parameter semantics are identical to the official API.
POST https://platform.dataeyes.ai/kling/v1/videos/effects| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Type | string | Yes | application/json | Data Exchange Format |
Authorization | string | Yes | Authentication information, refer to API authentication |
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
effect_scene | string | Yes | Scene Name - Enum values: football_dance, magic_world_vlog, air_dunk, whirling_beverage_9_16, tennis_trend, tennis_trend_9_16, ... (277 total, see full list below) - For more parameters, please refer to Video Effects Center | |
input | object | Yes | Task input structure. Fields vary depending on the scene. - Single-image effects (262 types available) Scenes include: football_dance, magic_world_vlog, air_dunk, whirling_beverage_9_16, tennis_trend, tennis_trend_9_16, ... (262 total, see full list below) - Dual-Image effects (15 types available) Scenes include: pet_skateboard, daily_ootd, toss_run, switch_to_silk, studio_look, french_elegance, finger_swipe, smooth_transition, kiss_pro, snow_night_kiss, eternal_kiss, cheers_2026, fight_pro, hug_pro, heart_gesture_pro | |
image | string | No | Reference Image (for single-image effects) - Supports image Base64 encoding or image URL (ensure accessibility) - Important: When using Base64, do NOT add any prefix like data:image/png;base64,. Submit only the raw Base64 string.- Correct Base64 format: - Incorrect Base64 format (with data: prefix): - Supported image formats: .jpg / .jpeg / .png - File size: ≤10MB, dimensions: ≥300px, aspect ratio: 1:2.5 ~ 2.5:1 | |
images | array | No | Reference Image Group (for dual-image effects) - Array length must be 2. The first image uploaded will be positioned on the left side of the composite photo, and the second image uploaded will be positioned on the right side. - This service includes composite photo functionality. Users upload two portrait images, and Kling AI will adaptively stitch them into a composite photo. (Composite Photo) - Supports image Base64 encoding or image URL (ensure accessibility) - Important: When using Base64, do NOT add any prefix like data:image/png;base64,. Submit only the raw Base64 string.- Correct Base64 format: - Incorrect Base64 format (with data: prefix): - Supported image formats: .jpg / .jpeg / .png - File size: ≤10MB, dimensions: ≥300px, aspect ratio: 1:2.5 ~ 2.5:1 | |
callback_url | string | No | The callback notification address for the result of this task. If configured, the server will actively notify when the task status changes. - For specific message schema, see Callback Protocol | |
external_task_id | string | No | Customized Task ID - User-defined task ID. It will not override the system-generated task ID, but supports querying tasks by this ID - Please note that it must be unique for each user | |
| Parameter Format Details |
effect_sceneinputimageiVBORw0KGgoAAAANSUhEUgAAAAUA...data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...imagesiVBORw0KGgoAAAANSUhEUgAAAAUA...data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...curl --request POST \
--url https://platform.dataeyes.ai/kling/v1/videos/effects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"effect_scene": "color_mixing",
"input": {
"image": "https://p4-kling.klingai.com/kcdn/cdn-kcdn112452/kling-op/effects_raw_pic/color_mixing.jpeg"
}
}'{
"code": 0, //Error codes;Specific definitions can be found in "Error Code"
"message": "string", //Error information
"request_id": "string", //Request ID, generated by the system
"data":{
"task_id": "string", //Task ID, generated by the system
"task_status": "string", //Task status, Enum values:submitted、processing、succeed、failed
"task_info": { //Task creation parameters
"external_task_id": "string" //Customer-defined task ID
},
"created_at": 1722769557708, //Task creation time, Unix timestamp, unit ms
"updated_at": 1722769557708 //Task update time, Unix timestamp, unit ms
}
}GET https://platform.dataeyes.ai/kling/v1/videos/effects/{id}| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Type | string | Yes | application/json | Data Exchange Format |
Authorization | string | Yes | Authentication information, refer to API authentication |
curl --request GET \
--url https://platform.dataeyes.ai/kling/v1/videos/effects/{task_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'{
"code": 0, // Error codes; Specific definitions can be found in Error codes
"message": "string", // Error information
"request_id": "string", // Request ID, generated by the system, is used to track requests and troubleshoot problems
"data": {
"task_id": "string", // Task ID, generated by the system
"task_status": "string", // Task status, Enum values: submitted, processing, succeed, failed
"task_status_msg": "string", // Task status information, displaying the failure reason when the task fails (such as triggering the content risk control of the platform, etc.)
"task_info": { //Task creation parameters
"external_task_id": "string" //Customer-defined task ID
},
"task_result": {
"videos": [
{
"id": "string", // Generated video ID; globally unique
"url": "string", // URL for generating videos, such as https://p1.a.kwimgs.com/bs2/upload-ylab-stunt/special-effect/output/HB1_PROD_ai_web_46554461/-2878350957757294165/output.mp4 (To ensure information security, generated images/videos will be cleared after 30 days. Please make sure to save them promptly.)
"watermark_url": "string", // Watermarked video download URL, anti-leech format
}
]
},
"watermark_info": {
"enabled": boolean
},
"final_unit_deduction": "string", // The deduction units of task
"created_at": 1722769557708, // Task creation time, Unix timestamp, unit: ms
"updated_at": 1722769557708 //Task update time, Unix timestamp, unit: ms
}
}GET https://platform.dataeyes.ai/kling/v1/videos/effects| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Type | string | Yes | application/json | Data Exchange Format |
Authorization | string | Yes | Authentication information, refer to API authentication |
curl --request GET \
--url 'https://platform.dataeyes.ai/kling/v1/videos/effects?pageNum=1&pageSize=30' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'{
"code": 0, // Error codes; Specific definitions can be found in Error codes
"message": "string", // Error information
"request_id": "string", // Request ID, generated by the system, is used to track requests and troubleshoot problems
"data": [
{
"task_id": "string", // Task ID, generated by the system
"task_status": "string", // Task status, Enum values: submitted, processing, succeed, failed
"task_status_msg": "string", // Task status information, displaying the failure reason when the task fails (such as triggering the content risk control of the platform, etc.)
"task_info": { //Task creation parameters
"external_task_id": "string" //Customer-defined task ID
},
"task_result": {
"videos": [
{
"id": "string", // Generated video ID; globally unique
"url": "string", // URL for generating videos, such as https://p1.a.kwimgs.com/bs2/upload-ylab-stunt/special-effect/output/HB1_PROD_ai_web_46554461/-2878350957757294165/output.mp4 (To ensure information security, generated images/videos will be cleared after 30 days. Please make sure to save them promptly.)
"watermark_url": "string", // Watermarked video download URL, anti-leech format
}
]
},
"final_unit_deduction": "string", // The deduction units of task
"created_at": 1722769557708, // Task creation time, Unix timestamp, unit: ms
"updated_at": 1722769557708 //Task update time, Unix timestamp, unit: ms
}
]
}