API Parameters

Prerequisites

Before creating a task, please ensure all required resources have been uploaded.

Upload File Limitations

Supported Formats: jpg|jpeg|png|webp (no animations)
Max File Size: 10MB
Max Image Resolution: 4096px

Request Body Parameters

modelImageKey (string, required): modelImageKey for the try-on process
top (object, optional): Top clothing configuration
- top.imageKey (string, optional): Uploaded image key for the top clothing item
bottom (object, optional): Bottom clothing configuration
- bottom.imageKey (string, optional): Uploaded image key for the bottom clothing item
onePiece (object, optional): One piece clothing configuration
- onePiece.imageKey (string, optional): Uploaded image key for the onePiece clothing item

Request Example

{
    "modelImageKey": "UPLOAD/MANAGE/SAMPLE/try-on-top/xxx.webp",
    "top": {
        "imageKey": "UPLOAD/MANAGE/SAMPLE/try-on-top/1-original.webp"
    }
}

Response Parameters

Success Response (200)

code (integer): Response code (0 for success)
data (object): Response data
data.id (string): Task ID for tracking
msg (string): Response message
success (boolean): Request success status
traceId (string): Request trace ID

Response Example

{
    "code": 0,
    "data": {
        "id": "string"
    },
    "msg": "string",
    "success": true,
    "traceId": "string"

}