Run an AI Cloth V4 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 or cannot be used in your integration, implement polling. After submitting an AI task, poll the status endpoint at regular intervals (e.g., every 10 seconds) until the task status is success or error.

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

filter_multi_personstring

Filter out multi-person cases in the source image and the human reference image.
off - No filtering. The engine uses the largest person in the image.
normal - Reject when another person is comparable in size to the main subject, or is clearly visible on the same plane, such as standing nearby with a sharp, recognizable face. Typical group or two-person photos. Distant or blurry background people are ignored.
strict - Reject when any additional person is visible, including small, distant, background, or blurry / out-of-focus people.

Default:"off"

Enum:"off""normal""strict"

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""outer"

POST

/s2s/v2.0/task/cloth-v4

curl -i -X POST \
  https://yce-api-01.makeupar.com/s2s/v2.0/task/cloth-v4 \
  -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,
    "filter_multi_person": "off"
  }'

Responses

Successful execution of the task

Bodyapplication/json

statusinteger

Response status

Example:200

dataobject

Response

{
  "status": 200,
  "data": {
    "task_id": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe"
  }
}