15-Element-Management
Element
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.
Create Element
POST https://platform.dataeyes.ai/kling/v1/general/advanced-custom-elementsRequest Headers
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Type | string | Yes | application/json | Data Exchange Format |
Authorization | string | Yes | Authentication information, refer to API authentication |
Request Body
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
element_name | string | Yes | Element Name Must not exceed 20 characters. | |
element_description | string | Yes | Element Description Must not exceed 100 characters. | |
reference_type | string | Yes | Reference Method Options: video_refer, image_refervideo_refer: Video Character Elements, at this time, the subject's appearance will be defined with reference to element_video_list. image_refer: Multi-Image Elements, whose appearance will be defined with reference to the element_image_list. The scope of availability differs between entities customized through videos and those customized through images. Please refer to the capability map and parameter specifications for details. | |
element_image_list | object | No | None | The main reference image allows for the setting of the element and its details through multiple images. Include front reference images and reference images from other angles or close-ups: at least one frontal reference image (frontal_image), and 1 to 3 additional reference images (image_url) that differ from the front. Load with key:value format as follows: Supports inputting image Base64 encoding or image URL (ensure accessibility). Supported image formats: .jpg / .jpeg / .png. Image file size cannot exceed 10MB, dimensions not less than 300px, aspect ratio between 1:2.5 ~ 2.5:1. When reference_type is image_refer, this parameter is required. |
element_video_list | object | No | None | The element is referenced by the video, and its details can be set through the video. Audio videos can be uploaded. If the audio video contains human voice, it will trigger voice customization (customization + inclusion in voice library + binding with the element). Currently, only realistic-style humanoid figures can be customized through video. Required when referencing videos; invalid when referencing images. Structure: element_video_list: { refer_videos: [{ video_url: "video_url_1" }] }. Only .mp4/.mov formats. Duration 3s–8s, 1080P, aspect ratio 16:9 or 9:16. At most 1 video, size not exceeding 200MB. video_url must not be empty. Video-customized elements are only supported for kling-video-o3 and later models. |
element_voice_id | string | No | None | The voice ID of element can be bound to existing tone colors in the tone library - When the current parameter is empty, the current entity is not bound to a tone color. - When binding voices to multi-image elements, only character image elements or humanoid image elements are supported - The ID can be obtained through the voice-related API. For details, see Voice Guide |
tag_list | array | No | None | Configure tags for the subject, one subject can configure multiple tags. Structure: tag_list: [{ tag_id: "o_101" }, { tag_id: "o_102" }, ...]. Tag ID and name: o_101 Hottest, o_102 Character, o_103 Animal, o_104 Item, o_105 Costume, o_106 Scene, o_107 Effect, o_108 Others. Tag and tag_id correspondence: tag_id — tag_name o_101 — Hottest o_102 — Character o_103 — Animal o_104 — Item o_105 — Costume o_106 — Scene o_107 — Effect o_108 — Others |
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 the specific message schema, see Callback Protocol | |
external_task_id | string | No | Customized Task ID. Users can provide a customized task ID, which will not overwrite the system-generated task ID but can be used for task queries. Please note that the customized task ID must be unique within a single user account. | |
| Parameter Format Details |
element_image_list"element_image_list": {
"frontal_image": "image_url_0",
"refer_images": [{ "image_url": "image_url_1" }, ...]
}element_video_list"element_video_list": {
"refer_videos": [{ "video_url": "video_url_1" }, ...]
}tag_list"tag_list": [ { "tag_id": "o_101" }, { "tag_id": "o_102" } ]Response Example
{
"code": 0, //Error codes; specific definitions see Error codes
"message": "string", //Error information
"request_id": "string", //Request ID, generated by the system, for tracking and troubleshooting
"data": {
"task_id": "string", //Task ID, generated by the system
"task_info": { //Task creation parameters
"external_task_id": "string" //Customer-defined task ID
},
"task_status": "string", //Task status: submitted, processing, succeed, failed
"created_at": 1722769557708, //Task creation time, Unix timestamp, ms
"updated_at": 1722769557708 //Task update time, Unix timestamp, ms
}
}Query Custom Element (Single)
GET https://platform.dataeyes.ai/kling/v1/general/advanced-custom-elements/{id}Request Headers
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Type | string | Yes | application/json | Data Exchange Format |
Authorization | string | Yes | Authentication information, refer to API authentication |
Response Example
{
"code": 0, //Error codes; specific definitions see Error codes
"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: submitted, processing, succeed, failed
"task_status_msg": "string", //Task status message, failure reason when failed
"task_info": { //Task creation parameters
"external_task_id": "string" //Customer-defined task ID
},
"task_result": {
"elements": [
{
"element_id": 0,
"element_name": "string",
"element_description": "string",
"reference_type": "video_refer",
"element_image_list": {},
"element_video_list": {},
"element_voice_info": {
"voice_id": "string", //Custom voice ID; globally unique
"voice_name": "string", //Custom voice name
"trial_url": "string", //Trial audio download URL
"owned_by": "kling" //Voice source, kling is official, number is creator ID
},
"tag_list": [],
"owned_by": "kling", //Element source, kling is official element library
"status": "succeed" //Element status: succeed when normal, deleted when removed
}
]
},
"final_unit_deduction": "string", //Final unit deduction for the task
"created_at": 1722769557708, //Task creation time, Unix timestamp, ms
"updated_at": 1722769557708 //Task update time, Unix timestamp, ms
}
}Query Custom Element (List)
GET https://platform.dataeyes.ai/kling/v1/general/advanced-custom-elementsRequest Headers
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Type | string | Yes | application/json | Data Exchange Format |
Authorization | string | Yes | Authentication information, refer to API authentication |
Response Example
{
"code": 0, //Error codes; specific definitions see Error codes
"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: submitted, processing, succeed, failed
"task_status_msg": "string", //Task status message
"task_info": { "external_task_id": "string" }, //Task creation parameters
"task_result": {
"elements": [
{
"element_id": 0,
"element_name": "string",
"element_description": "string",
"reference_type": "video_refer",
"element_image_list": {},
"element_video_list": {},
"element_voice_info": {},
"tag_list": [],
"owned_by": "kling", //Element source
"status": "succeed" //Element status: succeed, deleted
}
]
},
"final_unit_deduction": "string", //Final unit deduction
"created_at": 1722769557708, //Task creation time, Unix timestamp, ms
"updated_at": 1722769557708 //Task update time, Unix timestamp, ms
}
]
}Query Presets Element (List)
GET https://platform.dataeyes.ai/kling/v1/general/advanced-presets-elementsRequest Headers
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Type | string | Yes | application/json | Data Exchange Format |
Authorization | string | Yes | Authentication information, refer to API authentication |
Response Example
{
"code": 0, //Error codes; specific definitions see Error codes
"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: submitted, processing, succeed, failed
"task_status_msg": "string", //Task status message
"task_info": { "external_task_id": "string" }, //Task creation parameters
"task_result": {
"elements": [
{
"element_id": 0,
"element_name": "string",
"element_description": "string",
"reference_type": "video_refer",
"element_image_list": {},
"element_video_list": {},
"element_voice_info": {},
"tag_list": [],
"owned_by": "kling", //Element source
"status": "succeed" //Element status: succeed, deleted
}
]
},
"final_unit_deduction": "string", //Final unit deduction
"created_at": 1722769557708, //Task creation time, Unix timestamp, ms
"updated_at": 1722769557708 //Task update time, Unix timestamp, ms
}
]
}Delete Custom Element
POST https://platform.dataeyes.ai/kling/v1/general/delete-elementsRequest Headers
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Type | string | Yes | application/json | Data Exchange Format |
Authorization | string | Yes | Authentication information, refer to API authentication |
Request Body
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
element_id | string | Yes | The ID of the element to be deleted; only supports deleting custom elements. |
Response Example
{
"code": 0, //Error codes; specific definitions see Error codes
"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: submitted, processing, succeed, failed
}
}