{
  "Create Task": "Create Task\nPOST\n/v1/videos/multi-elements\ncURL\nCopy\nCollapse\ncurl --request POST \\\n--url https://api-singapore.klingai.com/v1/videos/multi-elements \\\n--header 'Authorization: Bearer <token>' \\\n--header 'Content-Type: application/json' \\\n--data '{\n\"model_name\": \"kling-v1-6\",\n\"session_id\": \"847570360458960960\",\n\"edit_mode\": \"removal\",\n\"image_list\": [],\n\"prompt\": \"Delete the chick from <<<video_1>>>\",\n\"negative_prompt\": \"\",\n\"mode\": \"std\",\n\"duration\": \"5\",\n\"callback_url\": \"\",\n\"external_task_id\": \"\"\n}'\n200\nCopy\nCollapse\n{\n\"code\": 0, // Error code; Specific definitions can be found in \"Error Code\"\n\"message\": \"string\", // Error message\n\"request_id\": \"string\", // Request ID, generated by the system, used for tracking requests and troubleshooting\n\"data\": {\n\"task_id\": \"string\", // Task ID, generated by the system\n\"task_status\": \"string\", // Task status, Enum values: submitted, processing, succeed, failed\n\"task_info\": {\n\"external_task_id\": \"string\" // User-defined task ID\n},\n\"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n\"updated_at\": 1722769557708 // Task update time, Unix timestamp, unit: ms\n}\n}\nRequest Header\nContent-Type\nstring\nRequired\nDefault to application/json\nData Exchange Format\nAuthorization\nstring\nRequired\nAuthentication information, refer to API authentication\nRequest Body\nmodel_name\nstring\nOptional\nDefault to kling-v1-6\nModel Name\nEnum values：\nkling-v1-6\nsession_id\nstring\nRequired\nSession ID, generated during the video initialization task and remains unchanged during editing operations\nedit_mode\nstring\nRequired\nOperation Type\nEnum values：\naddition\nswap\nremoval\naddition: Add an element\nswap: Replace an element\nremoval: Remove an element\nimage_list\narray\nOptional\nCropped Reference Images\nFor adding video elements: This parameter is required; upload 1–2 images\nFor editing (swapping) video elements: This parameter is required; upload 1 image only\nFor deleting video elements: This parameter is not required\nUse key:value format as follows:\n\"image_list\":[\n{ \"image\":\"image_url\" },\n{ \"image\":\"image_url\" }\n]\nThe API does not perform cropping, please upload images with subjects already cropped\nSupports image input as either Base64-encoded string or URL (ensure the URL is publicly accessible)\nImportant: When using Base64, do NOT add any prefix like data:image/png;base64,. Submit only the raw Base64 string.\nCorrect Base64 format:\niVBORw0KGgoAAAANSUhEUgAAAAUA...\nIncorrect Base64 format (with data: prefix):",
  "Parameters": "\"task_info\": { // Task creation parameters\n\"external_task_id\": \"string\" // User-defined task ID\n},\n\"task_result\": {\n\"videos\": [\n{\n\"id\": \"string\", // Generated video ID, globally unique\n\"session_id\": \"id\", // Session ID, generated during video initialization task, remains unchanged during editing operations, valid for 24 hours\n\"url\": \"string\", // URL of generated video (Note: For security purposes, generated images/videos will be deleted after 30 days, please save them promptly)\n\"watermark_url\": \"string\", // Watermarked video download URL, anti-hotlinking format\n\"duration\": \"string\" // Total video duration, unit: s\n}\n]\n},\n\"watermark_info\": {\n\"enabled\": boolean\n},\n\"final_unit_deduction\": \"string\", // Final unit deduction for the task\n\"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n\"updated_at\": 1722769557708 // Task update time, Unix timestamp, unit: ms\n}\n}\nRequest Header\nContent-Type\nstring\nRequired\nDefault to application/json\nData Exchange Format\nAuthorization\nstring\nRequired\nAuthentication information, refer to API authentication\nPath Parameters\ntask_id\nstring\nOptional\nTask ID for Multi-Elements video editing\nRequest path parameter, fill the value directly in the request path\nYou can choose to query by external_task_id or task_id\nexternal_task_id\nstring\nOptional\nCustom Task ID for Multi-Elements video editing\nThe external_task_id filled in when creating the task. You can choose to query by external_task_id or task_id\nQuery Task (List)\nGET\n/v1/videos/multi-elements\ncURL\nCopy\nCollapse\ncurl --request GET \\\n--url 'https://api-singapore.klingai.com/v1/videos/multi-elements?pageNum=1&pageSize=30' \\\n--header 'Authorization: Bearer <token>'\n200\nCopy\nCollapse\n{\n\"code\": 0, // Error code; Specific definitions can be found in \"Error Code\"\n\"message\": \"string\", // Error message\n\"request_id\": \"string\", // Request ID, generated by the system, used for tracking requests and troubleshooting\n\"data\": [\n{\n\"task_id\": \"string\", // Task ID, generated by the system\n\"task_status\": \"string\", // Task status, Enum values: submitted, processing, succeed, failed\n\"task_status_msg\": \"string\", // Task status message, displays failure reason when task fails (e.g., triggered platform content moderation)\n\"task_info\": { // Task creation parameters\n\"external_task_id\": \"string\" // User-defined task ID\n},\n\"task_result\": {\n\"videos\": [\n{\n\"id\": \"string\", // Generated video ID, globally unique\n\"session_id\": \"id\", // Session ID, generated during video initialization task, remains unchanged during editing operations, valid for 24 hours\n\"url\": \"string\", // URL of generated video (Note: For security purposes, generated images/videos will be deleted after 30 days, please save them promptly)\n\"watermark_url\": \"string\", // Watermarked video download URL, anti-hotlinking format\n\"duration\": \"string\" // Total video duration, unit: s\n}\n]\n},\n\"watermark_info\": {\n\"enabled\": boolean\n},\n\"final_unit_deduction\": \"string\", // Final unit deduction for the task\n\"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n\"updated_at\": 1722769557708 // Task update time, Unix timestamp, unit: ms\n}\n]\n}\nRequest Header\nContent-Type",
  "Callback Protocol": "For the message schema, refer to the Callback Protocol\nexternal_task_id\nstring\nOptional\nCustom Task ID\nA user-defined task ID; it will not overwrite the system-generated task ID, but can be used to query the task\nPlease ensure uniqueness of the task ID within a single user account\nQuery Task (Single)\nGET\n/v1/videos/multi-elements/{id}\ncURL\nCopy\nCollapse\ncurl --request GET \\\n--url https://api-singapore.klingai.com/v1/videos/multi-elements/{task_id} \\\n--header 'Authorization: Bearer <token>'\n200\nCopy\nCollapse\n{\n\"code\": 0, // Error code; Specific definitions can be found in \"Error Code\"\n\"message\": \"string\", // Error message\n\"request_id\": \"string\", // Request ID, generated by the system, used for tracking requests and troubleshooting\n\"data\": {\n\"task_id\": \"string\", // Task ID, generated by the system\n\"task_status\": \"string\", // Task status, Enum values: submitted, processing, succeed, failed\n\"task_status_msg\": \"string\", // Task status message, displays failure reason when task fails (e.g., triggered platform content moderation)\n\"task_info\": { // Task creation parameters\n\"external_task_id\": \"string\" // User-defined task ID\n},\n\"task_result\": {\n\"videos\": [\n{\n\"id\": \"string\", // Generated video ID, globally unique\n\"session_id\": \"id\", // Session ID, generated during video initialization task, remains unchanged during editing operations, valid for 24 hours\n\"url\": \"string\", // URL of generated video (Note: For security purposes, generated images/videos will be deleted after 30 days, please save them promptly)\n\"watermark_url\": \"string\", // Watermarked video download URL, anti-hotlinking format\n\"duration\": \"string\" // Total video duration, unit: s\n}\n]\n},\n\"watermark_info\": {\n\"enabled\": boolean\n},\n\"final_unit_deduction\": \"string\", // Final unit deduction for the task\n\"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n\"updated_at\": 1722769557708 // Task update time, Unix timestamp, unit: ms\n}\n}\nRequest Header\nContent-Type\nstring\nRequired\nDefault to application/json\nData Exchange Format\nAuthorization\nstring\nRequired\nAuthentication information, refer to API authentication\nPath Parameters\ntask_id\nstring\nOptional\nTask ID for Multi-Elements video editing\nRequest path parameter, fill the value directly in the request path\nYou can choose to query by external_task_id or task_id\nexternal_task_id\nstring\nOptional\nCustom Task ID for Multi-Elements video editing\nThe external_task_id filled in when creating the task. You can choose to query by external_task_id or task_id\nQuery Task (List)\nGET\n/v1/videos/multi-elements\ncURL\nCopy\nCollapse\ncurl --request GET \\\n--url 'https://api-singapore.klingai.com/v1/videos/multi-elements?pageNum=1&pageSize=30' \\\n--header 'Authorization: Bearer <token>'\n200\nCopy\nCollapse\n{\n\"code\": 0, // Error code; Specific definitions can be found in \"Error Code\"\n\"message\": \"string\", // Error message\n\"request_id\": \"string\", // Request ID, generated by the system, used for tracking requests and troubleshooting\n\"data\": [\n{\n\"task_id\": \"string\", // Task ID, generated by the system"
}