Skip to content
/V3.0

V3.0

Upgraded the AI Clothes v3 engine to deliver exceptional fabric realism, accurately rendering materials such as leather, knitwear, and satin, while restoring intricate garment details with greater precision.

Operations

Run an AI Cloth V3 task.

Request

AI tasks are asynchronous. Prefer webhook-based completion handling when the feature supports webhooks. Configure your webhook endpoint, verify webhook signatures, and use the received task_id to query the task result after a success or error notification. See the webhook integration guide for setup and verification details.

If webhooks are not supported for the feature, or if your integration cannot use webhooks, implement polling. After starting an AI task, keep polling the task status endpoint at the given polling_interval until the task status is either success or error.

Do not stop polling a running task for longer than the allowed polling window. If the task is not polled in time, the task may expire; a later status check can return InvalidTaskId even if processing finished, and the consumed units may still be charged.

Security
BearerAuthenticationV2
Bodyapplication/jsonrequired
Any of:
change_shoesboolean

Control whether shoes should be swapped when a full body reference image with shoes is available for processing.
Have effect when garment_category is full_body or lower_body

Default:true
src_file_urlstringrequired

Url of the file to run task. The url should be publicly accessible.

Example:"https://example.com/selfie.jpg"
ref_file_urlstringrequired

Url of the reference file to run task. The url should be publicly accessible.

Example:"https://example.com/accessory.jpg"
garment_categorystringrequired

The category of garment of reference image. It's required if reference image provided. Utilize the "auto" parameter to allow the AI engine to automatically identify and classify garment categories.

Enum:"full_body""lower_body""upper_body""shoes""auto"
POST
/s2s/v2.0/task/cloth-v3
curl -i -X POST \
  https://yce-api-01.makeupar.com/s2s/v2.0/task/cloth-v3 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "src_file_url": "https://example.com/selfie.jpg",
    "ref_file_url": "https://example.com/accessory.jpg",
    "garment_category": "full_body",
    "change_shoes": true
  }'

Responses

Successful execution of the task

Bodyapplication/json
statusinteger

Response status

Example:200
dataobject
Response
{
  "status": 200,
  "data": {
    "task_id": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe"
  }
}