# AI Shoes Virtual Try-On # Overview Step into the future of shopping with our AR Shoes Virtual Try-On. Instantly see how your favourite styles look and fit right from your screen. Powered by cutting-edge AI technology, this experience delivers a perfect visual fit, helping you shop with confidence and reduce returns. Explore endless styles and colours from the comfort of home. Our high-fidelity AR simulation brings every detail to life so you can enjoy the thrill of an in-store experience anytime, anywhere. Try it today and find the perfect pair that matches your style. ## Integration Guide This guide walks you through: * **Endpoint:** `/s2s/v2.0/task/shoes-transfer` * **Authentication:** All requests require an `Authorization: Bearer YOUR_API_KEY` * **Workflow:** 1. **Prepare a selfie image:** Uploading an image or providing a valid image URL of yourself as the virtual try-on target. 2. **Prepare a shoes image:** Upload a shoe product image or a photo of a person wearing shoes. 3. **Select a style and a gender:** Select a preferred style and the gender you wish to visualize. 4. **Fire an AI task and Retrieve Task ID:** Capture the `task_id` from the response. 5. **Poll Status (`GET`):** Use the `task_id` to check the status of the task. Continue polling until `task_status` is `"success"` or `"error"` . --- * Authentication - Include your API key in the request header using **Bearer Token** : ``` Authorization: Bearer YOUR_API_KEY ``` You can find your API Key at https://yce.makeupar.com/api-console/en/api-keys/. --- * AI Shoes API Usage Guide This guide explains how to upload images, prepare reference shoes, and create virtual try-on tasks using the AI Shoes API. --- * Step 1. Prepare a Selfie Image You can: * Upload a selfie image using the File API (`/s2s/v2.0/file`), or * Provide a valid image URL. * Step 1.1 Upload a File Using the File API Use the **File API** (`/s2s/v2.0/file`) to upload a target user image. **Image Requirements:** * Upload a selfie photo. * Ensure the photo clearly shows your footwear. * Avoid backgrounds with multiple people or distracting objects. **Example Request:** ```bash curl --request POST \ --url https://yce-api-01.makeupar.com/s2s/v2.0/file \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'content-type: application/json' \ --data '{ "files": [ { "content_type": "image/jpg", "file_name": "selfie_photo_01_3dbd1b6683.jpg", "file_size": 547541 } ] }' ``` --- * Step 1.2. Retrieve File API Response The response includes: * `file_id` for creating an AI task. * `requests.url` for uploading the actual image file. **Sample Response:** ```json { "status": 200, "data": { "files": [ { "content_type": "image/jpg", "file_name": "selfie_photo_01_3dbd1b6683.jpg", "file_id": "SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9/13W5TOD8/u/FfjK3xgCQ+hRt9MJXBFaud", "requests": [ { "method": "PUT", "url": "https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...", "headers": { "Content-Length": "547541", "Content-Type": "image/jpg" } } ] } ] } } ``` --- * Step 1.3. Upload Image to Provided URL Use the `requests.url` from the File API response to upload the image: ```bash curl --location --request PUT 'https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...' \ --header 'Content-Type: image/jpg' \ --header 'Content-Length: 547541' \ --data-binary @'./selfie_photo_01_3dbd1b6683.jpg' ``` --- * Step 2. Prepare a Reference Shoes Image You can: * Upload a shoe image using the File API ( `/s2s/v2.0/file` ), or * Provide a valid image URL. **Supported Shoes Images:** * A shoe product image. * A photo of a person wearing shoes. Refer to **[File Specs and Errors](#section/overview/File-Specs-and-Errors)** for detailed specifications. --- * Step 3. Create an AI Task Select a preferred style and the gender you wish to visualize. Use the **AI Task API** (`/s2s/v2.0/task/shoes-transfer`) to create a virtual try-on task. **Parameters:** * For the user image: `src_file_id` or `src_file_url` . * For the shoes image: `ref_file_id` , or `ref_file_url` . **Example Request:** ```bash curl --request POST \ --url https://yce-api-01.makeupar.com/s2s/v2.0/task/shoes-transfer \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'content-type: application/json' \ --data '{ "src_file_url": "https://example.com/selfie.jpg", "ref_file_url": "https://example.com/accessory.jpg", "gender": "female", "style": "random" }' ``` **Sample Response:** ```json { "status": 200, "data": { "task_id": "SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT" } } ``` --- * Step 4. Poll for Task Result Use the task ID to check the status: ```bash curl --request GET \ --url https://yce-api-01.makeupar.com/s2s/v2.0/task/shoes-transfer/SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'content-type: application/json' ``` --- * Step 5. Retrieve Result A successful response includes a download URL for the result image: ```json { "status": 200, "data": { "error": null, "results": { "url": "https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature..." }, "task_status": "success" } } ``` Invalid API Key error response: ```json { "status": 401, "error": "Unauthorized", "error_code": "InvalidAccessToken" } ``` --- ## File Specs & Errors * AI Shoes Virtual Try-On Specification * Image Requirements | Type | Minimum Resolution | Notes | | --- | --- | --- | | Selfie | 512 × 512 | Foot visible, full body preferred | | Shoes | 512 × 512 (product)800 × 800 (worn) | Clear, unobstructed shoes view | **Supported Shoes Image** * Product Image Requirements * Minimum resolution: 512 × 512 pixels * Only one product per image * The product should cover more than 25% of the image height ![](https://plugins-media.makeupar.com/strapi/assets/small_Shoes_3_428e8dddb1.jpg) * Worn Image Requirements * Minimum resolution: 800 × 800 pixels * Single Item Requirement: The model must wear exactly one item. Multiple items or accessories are not permitted. * Coverage Ratio: The worn item must occupy more than 20% of the total image height. This ensures the item is clearly visible and prominent within the frame. ![](https://plugins-media.makeupar.com/strapi/assets/small_Shoes_2_ec3578c5c2.jpg) ![](https://plugins-media.makeupar.com/strapi/assets/small_Shoes_9_52a61e0935.jpg) **Supported Selfie View** * Recommended image resolution: at least 512 × 512 pixels. * Single Subject Requirement: The image must contain exactly one human subject. No additional people or partial figures are allowed. * Foot Visibility: The subject's foot must be fully visible without obstruction. ![](https://plugins-media.makeupar.com/strapi/assets/small_clothes_04_441e848298.png) --- * Supported Formats & Dimensions | AI Feature | Supported Dimensions | Supported File Size | Supported Formats | | --- | --- | --- | --- | | AI Shoes Virtual Try-On | Input: long side <= 4096 Output: 1008 x 1344 | < 10MB | jpg/jpeg/png/heic | * Error Codes | Error Code | Description | | --- | --- | | error_download_image | Failed to download source or reference image | | error_inference | Inference pipeline error | | error_no_face | No face detected in source image | | error_nsfw_content_detected | NSFW content detected in result | | exceed_max_filesize | File size exceeds 10 MB | | invalid_parameter | Invalid gender or style value | | unknown_internal_error | Other internal errors | * Environment & Dependency | Sample Code Language / Tool | Recommended Runtime Versions | | --- | --- | | cURL | - bash >= 3.2 - curl >= 7.58 (modern TLS/HTTP support) - jquery >= 1.6 (robust JSON parsing) | | Node.js (JavaScript) | Node >= 18 (for global fetch) | | JavaScript | - Chrome / Edge >= 80 - Firefox >= 74 - Safari >= 13.1 | | PHP | PHP >= 7.4 (for modern TLS/compat), ext-curl (recommended) or allow_url_fopen=On + ext-openssl, ext-json | | Python | Python >= 3.10 (for f-strings), requests >= 2.20.0 | | Java | Java 11+ (for HttpClient), Jackson Databind >= 2.12.0 | --- ## Unit Consumption | AI Feature | Unit Consumed | | --- | --- | | AI Shoes Virtual Try-On V2.0 | 2 | | AI Shoes Virtual Try-On V3.0 | 2 | --- License: Privacy policy ## Servers ``` https://yce-api-01.makeupar.com ``` ## Security ### BearerAuthenticationV2 Use the standard 'Bearer authentication'. Put your 'API Key' in header: `Authorization:Bearer YOUR_API_KEY`. Notice that there is ' ' a space between 'Bearer' and the 'YOUR_API_KEY'. Type: http Scheme: bearer ## Download OpenAPI description - [AI Shoes Virtual Try-On](https://docs.perfectcorp.com/_bundle/reference/ai_shoes.yaml) ## V3.0 - [POST /s2s/v2.0/task/shoes-transfer](https://docs.perfectcorp.com/reference/ai_shoes/v3.0/paths/~1s2s~1v2.0~1task~1shoes-transfer/post.md): 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 qu - [GET /s2s/v2.0/task/shoes-transfer/{task_id}](https://docs.perfectcorp.com/reference/ai_shoes/v3.0/paths/~1s2s~1v2.0~1task~1shoes-transfer~1%7Btask_id%7D/get.md) ## V2.0 - [POST /s2s/v2.0/task/shoes](https://docs.perfectcorp.com/reference/ai_shoes/v2.0/paths/~1s2s~1v2.0~1task~1shoes/post.md): This endpoint initiates the shoes virtual try-on process. You must provide a source file, reference files (URL or ID), specify gender and style parameters. The task will be processed asynchronously, a - [GET /s2s/v2.0/task/shoes/{task_id}](https://docs.perfectcorp.com/reference/ai_shoes/v2.0/paths/~1s2s~1v2.0~1task~1shoes~1%7Btask_id%7D/get.md)