{
  "openapi": "3.1.0",
  "info": {
    "title": "Kling Virtual Try-On API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.cometapi.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/kling/v1/images/kolors-virtual-try-on": {
      "post": {
        "summary": "Create a Kling virtual try-on",
        "operationId": "kling_virtual_try_on",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "required": false,
            "description": "Must be `application/json`.",
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "human_image",
                  "cloth_image"
                ],
                "properties": {
                  "model_name": {
                    "type": "string",
                    "description": "Virtual try-on model version. Defaults to `kolors-virtual-try-on-v1`.",
                    "enum": [
                      "kolors-virtual-try-on-v1",
                      "kolors-virtual-try-on-v1-5"
                    ],
                    "default": "kolors-virtual-try-on-v1"
                  },
                  "human_image": {
                    "type": "string",
                    "description": "Person image to dress. Image URL or raw Base64 string without a `data:` prefix. Supported formats: JPG, JPEG, PNG. Maximum 10 MB, minimum 300x300 px, aspect ratio between 1:2.5 and 2.5:1."
                  },
                  "cloth_image": {
                    "type": "string",
                    "description": "Clothing image for the try-on. Image URL or raw Base64 string without a `data:` prefix. Supported formats: JPG, JPEG, PNG. Maximum 10 MB, minimum 300x300 px, aspect ratio between 1:2.5 and 2.5:1. Supports tops, bottoms, and one-piece dresses."
                  },
                  "callback_url": {
                    "type": "string",
                    "description": "Webhook URL for task status notifications."
                  },
                  "external_task_id": {
                    "type": "string",
                    "description": "Optional user-defined task ID for your own tracking. Must be unique per account."
                  }
                },
                "default": {
                  "model_name": "kolors-virtual-try-on-v1",
                  "human_image": "https://your-image-host/person.jpg",
                  "cloth_image": "https://your-image-host/garment.jpg"
                }
              },
              "examples": {
                "Default": {
                  "summary": "Virtual try-on request",
                  "value": {
                    "model_name": "kolors-virtual-try-on-v1",
                    "human_image": "https://your-image-host/person.jpg",
                    "cloth_image": "https://your-image-host/garment.jpg"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Task request accepted or an error response returned by the API.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "code",
                    "message",
                    "data"
                  ],
                  "properties": {
                    "code": {
                      "oneOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "string"
                        }
                      ],
                      "description": "Response code. `0` means the task request was accepted."
                    },
                    "message": {
                      "type": "string",
                      "description": "Response message."
                    },
                    "request_id": {
                      "type": "string",
                      "description": "Request identifier returned when present."
                    },
                    "data": {
                      "type": "object",
                      "required": [
                        "task_id",
                        "task_status",
                        "created_at",
                        "updated_at"
                      ],
                      "properties": {
                        "task_id": {
                          "type": "string",
                          "description": "System-generated task ID."
                        },
                        "task_status": {
                          "type": "string",
                          "description": "Task status.",
                          "enum": [
                            "submitted",
                            "processing",
                            "succeed",
                            "failed"
                          ]
                        },
                        "task_status_msg": {
                          "oneOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Task status detail when present."
                        },
                        "task_info": {
                          "type": "object",
                          "properties": {
                            "external_task_id": {
                              "oneOf": [
                                {
                                  "type": "string"
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Caller-provided external task ID when supplied."
                            }
                          },
                          "additionalProperties": true
                        },
                        "task_result": {
                          "oneOf": [
                            {
                              "type": "object",
                              "additionalProperties": true
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Task result payload after the task completes."
                        },
                        "created_at": {
                          "type": "integer",
                          "description": "Task creation time as a Unix timestamp in milliseconds."
                        },
                        "updated_at": {
                          "type": "integer",
                          "description": "Task update time as a Unix timestamp in milliseconds."
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "additionalProperties": true
                }
              }
            }
          }
        },
        "x-codeSamples": [
          {
            "lang": "Shell",
            "label": "Default",
            "source": "curl https://api.cometapi.com/kling/v1/images/kolors-virtual-try-on \\\n  -H \"Authorization: Bearer $COMETAPI_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n  \"model_name\": \"kolors-virtual-try-on-v1\",\n  \"human_image\": \"https://your-image-host/person.jpg\",\n  \"cloth_image\": \"https://your-image-host/garment.jpg\"\n}'\n"
          },
          {
            "lang": "Python",
            "label": "Default",
            "source": "import os\nimport requests\n\nresponse = requests.post(\n    \"https://api.cometapi.com/kling/v1/images/kolors-virtual-try-on\",\n    headers={\"Authorization\": \"Bearer \" + os.environ[\"COMETAPI_KEY\"]},\n    json={\n    \"model_name\": \"kolors-virtual-try-on-v1\",\n    \"human_image\": \"https://your-image-host/person.jpg\",\n    \"cloth_image\": \"https://your-image-host/garment.jpg\"\n},\n)\n\nresult = response.json()\nprint(result[\"code\"], result.get(\"data\", {}).get(\"task_id\"))\n"
          },
          {
            "lang": "JavaScript",
            "label": "Default",
            "source": "const response = await fetch(\"https://api.cometapi.com/kling/v1/images/kolors-virtual-try-on\", {\n  method: \"POST\",\n  headers: {\n    Authorization: `Bearer ${process.env.COMETAPI_KEY}`,\n    \"Content-Type\": \"application/json\",\n  },\n  body: JSON.stringify({\n    \"model_name\": \"kolors-virtual-try-on-v1\",\n    \"human_image\": \"https://your-image-host/person.jpg\",\n    \"cloth_image\": \"https://your-image-host/garment.jpg\"\n}),\n});\n\nconst result = await response.json();\nconsole.log(result.code, result.data?.task_id);\n"
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Bearer token authentication. Use your CometAPI key."
      }
    }
  }
}