{
  "Create Task": "Create Task\nPOST\n/v1/images/multi-image2image\ncURL\nCopy\nCollapse\ncurl --request POST \\\n--url https://api-singapore.klingai.com/v1/images/multi-image2image \\\n--header 'Authorization: Bearer <token>' \\\n--header 'Content-Type: application/json' \\\n--data '{\n\"model_name\": \"kling-v2-1\",\n\"prompt\": \"Wearing a flowing red dress on the grassland, in Ghibli style.\",\n\"negative_prompt\": \"\",\n\"subject_image_list\": [\n{ \"subject_image\": \"https://v1-kling.klingai.com/kcdn/cdn-kcdn112452/kling-qa-test/multi-1.png\" },\n{ \"subject_image\": \"https://v1-kling.klingai.com/kcdn/cdn-kcdn112452/kling-qa-test/multi-2.png\" }\n],\n\"scene_image\": \"https://v1-kling.klingai.com/kcdn/cdn-kcdn112452/kling-qa-test/background.jpeg\",\n\"style_image\": \"https://v1-kling.klingai.com/kcdn/cdn-kcdn112452/kling-qa-test/16x9_jipuli.png\",\n\"n\": 2,\n\"aspect_ratio\": \"9:16\"\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_info\": { //Task creation parameters\n\"external_task_id\": \"string\" //User-defined task ID\n},\n\"task_status\": \"string\", // Task status, Enum values: submitted, processing, succeed, failed\n\"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n\"updated_at\": 1722769557708 //Task update time, Unix timestamp, unit: ms\n}\n}\nGenerate images based on multiple reference images (subject, scene, style).\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-v2\nModel Name\nEnum values：\nkling-v2\nkling-v2-1\nprompt\nstring\nOptional\nPositive text prompt\nCannot exceed 2500 characters\nsubject_image_list\narray\nRequired\nSubject Reference Images\nSupport up to 4 images, at least 1 image, using key:value format as follows:\n\"subject_image_list\":[\n{ \"subject_image\":\"image_url\" },\n{ \"subject_image\":\"image_url\" },\n{ \"subject_image\":\"image_url\" },\n{ \"subject_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):\ndata:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...\nSupported image formats: .jpg / .jpeg / .png\nImage file size must not exceed 10MB. Image dimensions must be at least 300px in width and height. Aspect ratio must be between 1:2.5 and 2.5:1\n▾\nHide child attributes\nsubject_image\nstring\nRequired",
  "Parameters": "\"task_info\": { //Task creation parameters\n\"external_task_id\": \"string\" //User-defined task ID\n},\n\"task_status\": \"string\", // Task status, Enum values: submitted, processing, succeed, failed\n\"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n\"updated_at\": 1722769557708 //Task update time, Unix timestamp, unit: ms\n}\n}\nGenerate images based on multiple reference images (subject, scene, style).\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-v2\nModel Name\nEnum values：\nkling-v2\nkling-v2-1\nprompt\nstring\nOptional\nPositive text prompt\nCannot exceed 2500 characters\nsubject_image_list\narray\nRequired\nSubject Reference Images\nSupport up to 4 images, at least 1 image, using key:value format as follows:\n\"subject_image_list\":[\n{ \"subject_image\":\"image_url\" },\n{ \"subject_image\":\"image_url\" },\n{ \"subject_image\":\"image_url\" },\n{ \"subject_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):\ndata:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...\nSupported image formats: .jpg / .jpeg / .png\nImage file size must not exceed 10MB. Image dimensions must be at least 300px in width and height. Aspect ratio must be between 1:2.5 and 2.5:1\n▾\nHide child attributes\nsubject_image\nstring\nRequired\nSubject image URL or Base64 string\nscene_image\nstring\nOptional\nScene Reference Image\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):\ndata:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...\nSupported image formats: .jpg / .jpeg / .png\nImage file size must not exceed 10MB. Image dimensions must be at least 300px in width and height. Aspect ratio must be between 1:2.5 and 2.5:1\nstyle_image\nstring\nOptional\nStyle Reference Image\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):\ndata:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...\nSupported image formats: .jpg / .jpeg / .png\nImage file size must not exceed 10MB. Image dimensions must be at least 300px in width and height. Aspect ratio must be between 1:2.5 and 2.5:1\nn\nint\nOptional\nDefault to 1\nNumber of generated images\nValue range: [1, 9]\naspect_ratio",
  "Callback Protocol": "The specific message schema of the notification can be found in Callback Protocol\nexternal_task_id\nstring\nOptional\nCustomized Task ID\nUser-defined task ID. It will not override the system-generated task ID, but supports querying tasks by this ID\nPlease note that it must be unique for each user\nQuery Task (Single)\nGET\n/v1/images/multi-image2image/{id}\ncURL\nCopy\nCollapse\ncurl --request GET \\\n--url https://api-singapore.klingai.com/v1/images/multi-image2image/{id} \\\n--header 'Authorization: Bearer <token>'\n200\nCopy\nCollapse\n{\n\"code\": 0, // Error codes; specific definitions see Error codes\n\"message\": \"string\", // Error information\n\"request_id\": \"string\", // Request ID, generated by the system\n\"data\": {\n\"task_id\": \"string\", // Task ID, generated by the system\n\"task_info\": { //Task creation parameters\n\"external_task_id\": \"string\" //Customer-defined task ID\n},\n\"task_status\": \"string\", // Task status: submitted, processing, succeed, failed\n\"task_status_msg\": \"string\", // Task status message, failure reason when task fails\n\"final_unit_deduction\": \"string\", // Final unit deduction for the task\n\"watermark_info\": { \"enabled\": boolean },\n\"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n\"updated_at\": 1722769557708, // Task update time, Unix timestamp, unit: ms\n\"task_result\": {\n\"images\": [\n{\n\"index\": 0, // Image number, 0-9\n\"url\": \"string\", // URL for generated image (Generated images/videos will be cleared after 30 days. Please save promptly.)\n\"watermark_url\": \"string\" // Watermarked image download URL, anti-hotlinking format\n}\n]\n}\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\nRequired\nThe task ID for image generation. Request path parameter, directly fill the value in the request path. Query by external_task_id or task_id.\nexternal_task_id\nstring\nOptional\nCustomized Task ID for audio generation\nThe external_task_id filled in when creating the task. You can choose to query by external_task_id or task_id\nWhen creating a task, you can choose to query by external_task_id or task_id.\nQuery Task (List)\nGET\n/v1/images/multi-image2image\ncURL\nCopy\nCollapse\ncurl --request GET \\\n--url 'https://api-singapore.klingai.com/v1/images/multi-image2image?pageNum=1&pageSize=30' \\\n--header 'Authorization: Bearer <token>'\n200\nCopy\nCollapse\n{\n\"code\": 0, // Error codes; specific definitions see Error codes\n\"message\": \"string\", // Error information\n\"request_id\": \"string\", // Request ID, generated by the system\n\"data\": [\n{\n\"task_id\": \"string\", // Task ID, generated by the system\n\"task_info\": { //Task creation parameters\n\"external_task_id\": \"string\" //Customer-defined task ID\n},\n\"task_status\": \"string\", // Task status: submitted, processing, succeed, failed\n\"task_status_msg\": \"string\", // Task status message"
}