# AI Makeup Virtual Try-On # Overview The AI Makeup API provides a powerful, hyper-realistic virtual makeover experience powered by our patented face-analyzing technology. This service enables your applications to apply true-to-life makeup effects onto user-provided selfie images with unprecedented customization capabilities. **Key Features:** * **Hyper-realistic Rendering:** Leverages revolutionary 3D face AI technology for the most realistic makeovers. * **Patented Technology:** Powered by jitter-free, lag-free deep learning algorithms optimized for all ages and ethnicities. * **Real-time Precision:** Ultra-precise facial tracking that adapts to various lighting conditions. * **True-to-life Matching:** Accurately matches real-world product colors, textures (from matte to metallic), and finishes. * Core Concepts * Color Blending Our AI accurately matches the color of real-life makeup products using deep learning. This ensures consumers are confident that the virtual color they see is the true color of the product they intend to purchase. * Texture & Finish Matching The technology simulates realistic textures and finishes, providing a highly accurate makeover experience. From matte to metallic, shimmer to satin, the AI taps into advanced algorithms to render these effects seamlessly in real-time. * Light Balancing The smart 3D AI engine detects lighting conditions in the user's photo or video feed. It corrects images for true-to-life makeup application, ensuring a consistent and high-quality result regardless of the environment. --- ## Integration Guide The Makeup Virtual Try-On service operates as an asynchronous task. You must first initiate a makeup processing task by providing the image URL and a list of desired effects. The server responds with a `task_id`. You then periodically poll a status endpoint to retrieve the final result or any errors. * **Endpoint:** `/v2.0/task/makeup-vto` * **Authentication:** All requests require an `Authorization: Bearer ` * **Workflow:** 1. **Prepare a selfie:** Upload an image or use existing file url of a face image. 1. **Start Task (`POST`):** Submit your image id/URL and makeup configuration. 1. **Retrieve Task ID:** Capture the `task_id` from the response. 1. **Poll Status (`GET`):** Use the `task_id` to check the status of the task. Continue polling until `task_status` is `"success"` or `"error"`. * API Playground Interactively explore and test the API using our official playground: **API Playground:** [http://yce.makeupar.com/api-console/en/api-playground/ai-makeup-virtual-try-on/](http://yce.makeupar.com/api-console/en/api-playground/ai-makeup-virtual-try-on/) --- * Authentication - Include your API key in the request header using **Bearer Token**: ``` Authorization: Bearer ``` You can find your API Key at https://yce.makeupar.com/api-console/en/api-keys/. * 1. Upload a Selfie You can provide the source image in one of two ways: - **Use an Existing Public Image URL** Instead of uploading, you may supply a publicly accessible image URL directly when initiating the AI task. - **Upload via File API** Use the endpoint: ``` POST /s2s/v2.0/file/makeup-vto ``` This returns a `file_id` for subsequent task execution. - ***Important***: Simply calling the File API does not upload your file. You must **manually upload** the file to the **URL provided in the File API response**. That URL is your upload destination, make sure the file is successfully transferred there before proceeding.

Before calling the AI API, ensure your file has been successfully uploaded. Use the File API to retrieve an upload URL, then upload your file to that location. Once the upload is complete, you'll receive a ***file_id*** in the response, this ID is what you'll use to access AI features related to that file. > **Warning:** Please note that, you will get an 500 Server Error / unknown_internal_error or 404 Not Found error when using AI APIs if you do not upload the file to the URL provided in the File API response. * 2. Start Makeup Task `POST /s2s/v2.0/task/makeup-vto` Initiates a new virtual makeup task on the provided image. This endpoint is asynchronous and returns with a `task_id`. * Request Headers | Header | Value | |--------|-------| | Content-Type | `application/json` | | Authorization | `Bearer YOUR_API_KEY` | * Example Request Body ```json { "src_file_url": "https://plugins-media.makeupar.com/strapi/assets/sample_Image_1_202b6bf6e6.jpg", "effects": [ { "category": "blush", "pattern": { "name": "2colors6" }, "palettes": [ { "color": "#FF0000", "texture": "matte", "colorIntensity": 50 }, { "color": "#F2A53E", "texture": "matte", "colorIntensity": 50 } ] }, { "category": "eye_liner", "pattern": { "name": "3colors5" }, "palettes": [ { "color": "#000000", "texture": "matte", "colorIntensity": 50 }, { "color": "#BA0656", "texture": "matte", "colorIntensity": 50 }, { "color": "#089085", "texture": "matte", "colorIntensity": 50 } ] } ], "version": "1.0" } ``` * Request Body Schema | Field | Type | Description | |-------|------|---------| | `src_file_url` | string (URL) | A publicly accessible URL to the selfie image to be processed. | | `effects` | array of Effect | An array of makeup effects objects to apply. See [Makeup Effect Schemas](#makeup-effect-schemas) for details. | | `version` | string | The API version of the effect payload structure. Use `"1.0"`. | * Successful Response (`200 OK`) Returns a JSON object containing the task identifier. **Response Body Schema:** ```json { "status": 200, "data": { "task_id": "" } } ``` **Example Response:** ```json { "status": 200, "data": { "task_id": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe" } } ``` * Error Responses (`400 Bad Request`, `401 InvalidApiKey`, etc.) A standard error object will be returned with a message describing the failure. **Example Error Response:** ```json { "status": 400, "error": "The operation could not be completed", "error_code": "CreditInsufficiency" } ``` --- * 3. Get Task Status & Results `GET /s2s/v2.0/task/makeup-vto/` Retrieves the current status and results of an in-progress or completed task. * Request Headers | Header | Value | |--------|-------| | Authorization | `Bearer YOUR_API_KEY` | * Path Parameters | Parameter | Type | Description | |-----------|------|---------| | task_id | string | The identifier returned from the start-task endpoint. | * Successful Response (`200 OK`) A JSON object containing the status and, if completed, the results. **Response Body Schema:** ```json { "data": { "task_status": "", // 'success', 'error', or a processing state (e.g., 'queued', 'processing') "results": [ // present only when task_status is 'success' { "download_url": "" // URL to download the processed image } ], "failure_reason": "" // present only when task_status is 'error' } } ``` **Example Success Response:** ```json { "status": 200, "data": { "task_status": "success", "results": { "url": "https://s3.storage.prod/processed/image_123.jpg?token=..." } } } ``` **Example Engine Error Response:** The API query was sent successfully; however, an error occurred while executing the AI task. ```json { "status": 200, "data": { "task_status": "error", "error": "exceed_max_filesize", "error_message": "string", } } ``` > Please note that no units will be consumed if an error occurs, whether it is a query error or an engine error. **Example In-Progress Response:** ```json { "status": 200, "data": { "task_status": "running" } } ``` * Error Responses * `404 InvalidTaskId`: The `task_id` does not exist or is invalid. * `401 InvalidApiKey`: The API key is invalid or missing. * `500 TaskTimeout`: The task has either completed successfully or failed and has exceeded the retention period. **Example Query Error Response:** ```json { "status": 401, "error_code": "InvalidApiKey" } ``` > Please note that no units will be consumed if an error occurs, whether it is a query error or an engine error. --- ## Inputs & Outputs * Makeup Effect Schema This section defines the complete structure and constraints for the request body of an AI Makeup task. Each effect is an object in the top-level `effects` array. * Effect Container (Top Level) ```json { "version": "1.0", "effects": [] // array — Contains makeup effect objects } ``` * Makeup Effect Categories * `skin_smooth` ```json { "category": "skin_smooth", // string, const "skin_smooth" "skinSmoothStrength": 50, // integer, range: 0..100 "skinSmoothColorIntensity": 50 // integer, range: 0..100 } ``` > **Note!** If no ``skin_smooth`` effect is included in the request, the AI Makeup Engine will automatically apply a default Skin Smooth value of 50. Set all ``skinSmoothStrength`` and ``skinSmoothColorIntensity`` parameters to 0 if you want makeup applied with no skin smoothing. However, for best results and highest-quality blending, it is recommended to leave the default skin smoothing enabled. * `blush` ```json { "category": "blush", // string, const "blush" "pattern": { // object "name": "" // string — MUST equal a `label` from blush.json }, "palettes": [ // array, minItems: (see colorNum in pattern) { "color": "#ff0000", // string, hex color "#RRGGBB" "texture": "matte", // string, enum ["matte","satin","shimmer"] "glowStrength": 50, // integer, range: 0..100 — REQUIRED if texture="satin" "shimmerColor": "#fc288f", // string, hex color "#RRGGBB" — REQUIRED if texture="shimmer" "shimmerDensity": 50, // integer, range: 0..100 — REQUIRED if texture="shimmer" "colorIntensity": 50 // integer, range: 0..100 } ] } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/patterns/blush.json **Distinct Makeup Pattern Categories:** ```json [ { "category": "1 color", "label": "1color1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/483/a53cd4f4-43b6-4e19-b85a-ec7a95c6a47f.jpg", "tags": [ { "id": 100, "name": "Blush 3D" }, { "id": 103, "name": "Oblong" } ], "colorNum": 1 }, { "category": "2 colors", "label": "2colors1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/147/a8d86a4b-8aa0-48d7-a716-63ec78dfb30b.jpg", "tags": [ { "id": 100, "name": "Blush 3D" } ], "colorNum": 2 }, { "category": "3 colors", "label": "3colors1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/734/af8b625b-ae3a-4211-9413-f22c16a5f174.jpg", "tags": [ { "id": 100, "name": "Blush 3D" }, { "id": 104, "name": "Round" } ], "colorNum": 3 } ] ``` * `bronzer` ```json { "category": "bronzer", // string, const "bronzer" "pattern": { "name": "" }, // object — name MUST equal a `label` from bronzer.json "palettes": [ { "color": "#ff0000", "colorIntensity": 50 } // hex color, int range: 0..100 ] } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/patterns/bronzer.json **Distinct Makeup Pattern Categories:** ```json [ { "category": "Bronzer", "label": "Bronzer1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/973/22ff2c07-d584-4ae6-8281-c095cd121a52.jpg", "tags": [], "colorNum": 1 } ] ``` * `concealer` ```json { "category": "concealer", // string, const "concealer" "palettes": [ { "color": "#ff0000", // string, hex color "#RRGGBB" "colorIntensity": 50, // integer, range: 0..100 "colorUnderEyeIntensity": 50, // integer, range: 0..100 "coverageLevel": 50 // integer, range: 0..100 } ] } ``` * `contour` ```json { "category": "contour", // string, const "contour" "pattern": { "name": "" }, // object — name MUST equal a `label` from contour.json "palettes": [ { "color": "#ff0000", "colorIntensity": 50 } // hex color, int range: 0..100 ] } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/patterns/contour.json **Distinct Makeup Pattern Categories:** ```json [ { "category": "Heart face", "label": "HeartFace2", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/731/49a1b3b9-b393-4bf4-b486-1493fe468436.jpg", "tags": [] }, { "category": "Invtriangle", "label": "Invtriangle1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/858/a94c8cca-5f8c-4b8b-a02d-94edb6a4ad7f.jpg", "tags": [] }, { "category": "Oval face", "label": "OvalFace6", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/906/644368a3-7eee-4ad9-829e-e2b3d4320fec.jpg", "tags": [] }, { "category": "Round face", "label": "RoundFace4", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/106/3e455b5f-7e2d-46f7-8627-dc137051c144.jpg", "tags": [] }, { "category": "Triangle face", "label": "TriangleFace2", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/528/18765180-c254-4411-a25c-c1d78f5c3d77.jpg", "tags": [] } ] ``` * `eyebrows` ```json { "category": "eyebrows", // string, const "eyebrows" "pattern": { "type": "shape", // string, enum ["shape","color"], default: "shape" "name": "", // string, required when type="shape" — label from eyebrows.json "curvature": 0, // integer, range: -100..100 (shape only) "thickness": 0, // integer, range: -100..100 (shape only) "definition": 0 // integer, range: 0..100 (shape only) }, "palettes": [ { "color": "#ff0000", // string, hex color "#RRGGBB" "colorIntensity": 50, // integer, range: 0..100 "texture": "matte", // string, enum ["matte","shimmer"] "shimmerColor": "#fc288f", // string, hex color "#RRGGBB" — REQUIRED if texture="shimmer" "shimmerIntensity": 50, // integer, range: 0..100 — REQUIRED if texture="shimmer" "shimmerSize": 50, // integer, range: 0..100 — REQUIRED if texture="shimmer" "shimmerDensity": 50 // integer, range: 0..100 — REQUIRED if texture="shimmer" } ] } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/patterns/eyebrows.json **Distinct Makeup Pattern Categories:** ```json [ { "category": "Arrow", "label": "Arrow1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/490/1fb96bf9-979e-4327-a8c4-8c503f541f1a.jpg", "tags": [] }, { "category": "Curved", "label": "Curved1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/389/1ccb300e-c7ed-4995-920e-7d1bf8da1fad.jpg", "tags": [] }, { "category": "Drama", "label": "Drama2", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/196/5fb14bec-553d-4841-bba7-ca7e5e27c12e.jpg", "tags": [] }, { "category": "High Arch", "label": "HighArch1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/609/7a8676dc-6f6a-4b12-aab0-c50328e448c5.jpg", "tags": [] }, { "category": "Original", "label": "Original2", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/300/123551e9-ca94-4732-89ed-5b3866678555.jpg", "tags": [] }, { "category": "Soft Arch", "label": "SoftArch1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/121/2552ebf0-2705-43f7-b295-4fac21e18009.jpg", "tags": [] }, { "category": "Straight", "label": "Straight1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/1/7734e777-8e51-41f1-abaf-205f0ed5e3b4.jpg", "tags": [] }, { "category": "Thin", "label": "Thin1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/734/6ee10843-a251-4aa0-9183-db7f981d714d.jpg", "tags": [] }, { "category": "Upward", "label": "Upward4", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/751/76578317-f475-49c7-bd96-910ccad617ef.jpg", "tags": [] } ] ``` * `eye_liner` ```json { "category": "eye_liner", // string, const "eye_liner" "pattern": { "name": "" }, // object — name MUST equal a label from eyeliner.json "palettes": [ { "color": "#ff0000", // string, hex color "#RRGGBB" "texture": "matte", // string, enum ["matte","shimmer","metallic"] "shimmerColor": "#fc288f", // string, hex color "#RRGGBB" — REQUIRED if texture in ["shimmer","metallic"] "shimmerIntensity": 50, // integer, range: 0..100 — REQUIRED if texture in ["shimmer","metallic"] "metallicIntensity": 50, // integer, range: 0..100 — REQUIRED if texture="metallic" "colorIntensity": 50 // integer, range: 0..100 } ] } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/patterns/eyeliner.json **Distinct Makeup Pattern Categories:** ```json [ { "category": "2 colors", "label": "2colors1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/419/71d9429a-dc08-4e80-9c46-6e55631ef766.jpg", "tags": [ { "id": 28, "name": "Drama" } ], "colorNum": 2 }, { "category": "3 colors", "label": "3colors2", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/208/056aa6cd-8678-470c-b111-b7653d7ddf93.jpg", "tags": [ { "id": 28, "name": "Drama" } ], "colorNum": 3 }, { "category": "1 color", "label": "Arabic3", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/726/1919aad4-21a2-493a-a5f8-48bc99a61ba5.jpg", "tags": [ { "id": 26, "name": "Arabic" } ], "colorNum": 1 } ] ``` * `eye_shadow` ```json { "category": "eye_shadow", // string, const "eye_shadow" "pattern": { "name": "" }, // object — name MUST equal a label from eyeshadow.json "palettes": [ { "color": "#ff0000", // string, hex color "#RRGGBB" "texture": "matte", // string, enum ["matte","shimmer","metallic"] "shimmerColor": "#fc288f", // string, hex color "#RRGGBB" — REQUIRED if texture in ["shimmer","metallic"] "shimmerIntensity": 50, // integer, range: 0..100 — REQUIRED if texture in ["shimmer","metallic"] "metallicIntensity": 50, // integer, range: 0..100 — REQUIRED if texture="metallic" "colorIntensity": 50 // integer, range: 0..100 } ] // minItems: (see colorNum in pattern) } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/patterns/eyeshadow.json **Distinct Makeup Pattern Categories:** ```json [ { "category": "1 color", "label": "1color1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/188/0322c4f9-e54d-4a6b-8072-6bb76560121a.jpg", "tags": [ { "id": 12, "name": "Artistic" }, { "id": 14, "name": "Dream" }, { "id": 15, "name": "Trend" } ], "colorNum": 1 }, { "category": "2 colors", "label": "2colors1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/938/3348211c-1b83-4ab2-9c6a-ce06e4aa3528.jpg", "tags": [ { "id": 1, "name": "Fan shape" }, { "id": 8, "name": "Only upper lid" } ], "colorNum": 2 }, { "category": "3 colors", "label": "3colors1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/542/55e1b0fd-b888-47ff-bd3a-3dc1af2a7b69.jpg", "tags": [ { "id": 1, "name": "Fan shape" }, { "id": 8, "name": "Only upper lid" } ], "colorNum": 3 }, { "category": "4 colors", "label": "4colors1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/429/29cd5839-464b-4a7a-a5c1-c7b40e9464d7.jpg", "tags": [ { "id": 4, "name": "Closed banana" }, { "id": 10, "name": "Whole eye" } ], "colorNum": 4 }, { "category": "5 colors", "label": "5colors1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/2/824dcf7c-1273-4a30-8f1f-2137926057d6.jpg", "tags": [ { "id": 4, "name": "Closed banana" }, { "id": 10, "name": "Whole eye" } ], "colorNum": 5 } ] ``` * `eyelashes` ```json { "category": "eyelashes", // string, const "eyelashes" "pattern": { "name": "" }, // object — name MUST equal a label from eyelashes.json "palettes": [ { "color": "#ff0000", "colorIntensity": 50 } // hex color, int range: 0..100 ] } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/patterns/eyelashes.json **Distinct Makeup Pattern Categories:** ```json [ { "category": "Artistic", "label": "Artistic1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/146/7a8ed606-1c27-4d91-9320-c40a904f621f.jpg", "tags": [] }, { "category": "Natural", "label": "Natural1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/287/cd5cae75-a1b3-48f8-8537-e6e259213901.png", "tags": [] }, { "category": "Upper&Lower", "label": "Upper&Lower1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/18/2689ea2d-725e-4fa0-8563-df874ae1a83f.jpg", "tags": [] }, { "category": "Upper", "label": "Upper1", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/982/c99bf74e-545f-4da7-a314-f3bd84b82156.jpg", "tags": [] }, { "category": "UpperDense", "label": "UpperDense1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/888/452ec863-f0a8-40e7-aa33-31c0c39f57e2.jpg", "tags": [] }, { "category": "Winged", "label": "Winged1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/825/36ab3859-eae5-49e4-9d97-161698bbb8bb.jpg", "tags": [] }, { "category": "Wispies", "label": "Wispies1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/722/a2a727f6-748c-41e7-8ac0-c9c57c18c05a.png", "tags": [] } ] ``` * `foundation` ```json { "category": "foundation", // string, const "foundation" "palettes": [ { "color": "#ff0000", // string, hex color "#RRGGBB" "colorIntensity": 50, // integer, range: 0..100 "glowIntensity": 50, // integer, range: 0..100 "coverageIntensity": 50 // integer, range: 0..100 } ] } ``` * `highlighter` ```json { "category": "highlighter", // string, const "highlighter" "pattern": { "name": "" }, // object — name MUST equal a label from highlighter.json "palettes": [ { "color": "#ff0000", // string, hex color "#RRGGBB" "glowIntensity": 50, // integer, range: 0..100 "shimmerIntensity": 50, // integer, range: 0..100 "shimmerDensity": 50, // integer, range: 0..100 "shimmerSize": 50, // integer, range: 0..100 "colorIntensity": 50 // integer, range: 0..100 } ] } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/patterns/highlighter.json **Distinct Makeup Pattern Categories:** ```json [ { "category": "Heart face", "label": "HeartFace4", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/246/6ca40279-79cc-4918-b48a-64306009b365.jpg", "tags": [] }, { "category": "Invtriangle", "label": "Invtriangle2", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/7/6b0b9760-612c-4319-bd81-855d262d8e89.jpg", "tags": [] }, { "category": "Oblong", "label": "Oblong11", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/862/b7279f4e-edf2-43f3-8156-561fe5a52ec3.jpg", "tags": [] }, { "category": "Oval face", "label": "OvalFace2", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/369/91097a05-9fd2-43cb-82e9-dd45e72b613b.jpg", "tags": [] }, { "category": "Round face", "label": "RoundFace3", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/520/2d3ccbe2-36c3-43df-9e78-4c2c931fa431.jpg", "tags": [] }, { "category": "Square face", "label": "SquareFace3", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/989/2959777b-19ca-4f4a-a023-3c8927191497.jpg", "tags": [] }, { "category": "Triangle face", "label": "TriangleFace3", "thumbnail": "https://app-cdn-01.makeupar.com/console/customer/guest/SkuCustomImage/765/221c1f12-c621-4567-a8ee-1433038ee8a2.jpg", "tags": [] } ] ``` * `lip_color` ```json { "category": "lip_color", // string, const "lip_color" "shape": { // object — driven by lipshape.json "name": "original" // string — MUST equal a `label` from lipshape.json }, "morphology": { // optional object "fullness": 50, // integer, range: 0..100 (default: 0) "wrinkless": 50 // integer, range: 0..100 (default: 0) }, "palettes": [ // minItems depends on style; often ≥1 { "color": "#ff0000", // string, hex color "#RRGGBB" "texture": "matte", // string, enum ["matte","gloss","holographic","metallic","satin","sheer","shimmer"] "colorIntensity": 50, // integer, range: 0..100 "gloss": 50, // int, range: 0..100 — REQUIRED if texture in ["gloss","holographic","metallic","sheer","shimmer"] "shimmerColor": "#ff0000", // string, hex color "#RRGGBB" — REQUIRED if texture in ["holographic","metallic","shimmer"] "shimmerIntensity": 50, // integer, range: 0..100 — REQUIRED if texture in ["holographic","metallic","shimmer"] "shimmerDensity": 50, // integer, range: 0..100 — REQUIRED if texture in ["holographic","metallic","shimmer"] "shimmerSize": 50, // integer, range: 0..100 — REQUIRED if texture in ["holographic","metallic","shimmer"] "transparencyIntensity": 50 // integer, range: 0..100 — REQUIRED if texture in ["gloss","sheer","shimmer"] } ], "style": { "type": "full", // string, enum ["full","ombre","twoTone"] "innerRatio": 50, // int, range: 0..100 — REQUIRED if type="ombre" "featherStrength": 50 // int, range: 0..100 — REQUIRED if type="ombre" } } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/shapes/lipshape.json **Distinct Makeup Pattern Categories:** ```json [{ "category": "general", "label": "original", "thumbnail": "https://plugins-media.makeupar.com/wcm-saas/images/lipshapes/original.png", "tags": [ ] }, { "category": "general", "label": "heart-shaped", "thumbnail": "https://plugins-media.makeupar.com/wcm-saas/images/lipshapes/heart-shaped.jpg", "tags": [ ] }, { "category": "general", "label": "m-shaped", "thumbnail": "https://plugins-media.makeupar.com/wcm-saas/images/lipshapes/m-shaped.jpg", "tags": [ ] }, { "category": "general", "label": "petal", "thumbnail": "https://plugins-media.makeupar.com/wcm-saas/images/lipshapes/petal.jpg", "tags": [ ] }, { "category": "general", "label": "plump", "thumbnail": "https://plugins-media.makeupar.com/wcm-saas/images/lipshapes/plump.jpg", "tags": [ ] }, { "category": "general", "label": "pouty", "thumbnail": "https://plugins-media.makeupar.com/wcm-saas/images/lipshapes/pouty.jpg", "tags": [ ] }, { "category": "general", "label": "smile", "thumbnail": "https://plugins-media.makeupar.com/wcm-saas/images/lipshapes/smile.jpg", "tags": [ ] }, { "category": "general", "label": "vintage", "thumbnail": "https://plugins-media.makeupar.com/wcm-saas/images/lipshapes/vintage.jpg", "tags": [ ] } ] ``` * `lip_liner` ```json { "category": "lip_liner", // string, const "lip_liner" "pattern": { "name": "" }, // object — name MUST equal a label from lipliner.json "palettes": [ { "color": "#ff0000", // string, hex color "#RRGGBB" "texture": "matte", // string, enum ["matte","satin"] "colorIntensity": 50, // integer, range: 0..100 "thickness": 50, // integer, range: 0..100 "smoothness": 50 // integer, range: 0..100 } ] } ``` **Full Pattern Catalog:** https://plugins-media.makeupar.com/wcm-saas/patterns/lipliner.json **Distinct Makeup Pattern Categories:** ```json [ { "category": "Large & Full", "label": "Large&Full1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/417/7ac66cb2-2c7b-451c-8284-cc77791b7001.jpg", "tags": [] }, { "category": "Larger Lower", "label": "LargerLower1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/878/84b2ef48-3af4-4851-86d2-b01d10db82b2.jpg", "tags": [] }, { "category": "Larger Upper", "label": "LargerUpper1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/867/674f9f4c-7961-462e-8cc9-9a8acaad4168.jpg", "tags": [] }, { "category": "Natural", "label": "Natural1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/258/7533c08a-cc9c-45ab-9294-5d5a8114037d.jpg", "tags": [] }, { "category": "Rosebud", "label": "Rosebud1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/47/eb95e91f-6ef1-41f7-bc4f-aecd7d780c42.jpg", "tags": [] }, { "category": "Small", "label": "Small1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/396/6b78e461-24a6-4c6d-afb4-88beb71f1732.jpg", "tags": [] }, { "category": "Wider", "label": "Wider1", "thumbnail": "https://app-cdn-01.makeupar.com/console/SkuCustomImage/guest/867/21f92b70-72b5-4a57-b4d7-81c5cce757a6.jpg", "tags": [] } ] ``` --- ## Example Payload Here is a full example of a valid `effectJson` payload applying multiple effects. ```json { "version": "1.0", "effects": [ { "category": "skin_smooth", "skinSmoothStrength": 55, "skinSmoothColorIntensity": 45 }, { "category": "blush", "pattern": { "name": "2colors1" }, "palettes": [ { "color": "#e19f9f", "texture": "matte", "colorIntensity": 60, "shimmerColor": "#d63252", "shimmerDensity": 50 }, { "color": "#c98a8a", "texture": "satin", "glowStrength": 40, "colorIntensity": 70 } ] }, { "category": "lip_color", "shape": { "name": "plump" }, "morphology": { "fullness": 30, "wrinkless": 25 }, "style": { "type": "full" }, "palettes": [ { "color": "#e11c43", "texture": "gloss", "colorIntensity": 80, "gloss": 75 } ] } ] } ``` In this example, `blush` uses the the `2colors1` pattern from the `blush.json`, which requires exactly two palettes. The `lip_color` effect uses the the `plump` shape from `lipshape.json`. ## File Specs & Errors * Supported Formats & Dimensions |AI Feature|Supported Dimensions|Supported File Size|Supported Formats| | ---- | ---- | ---- | ---- | |AI Makeup Virtual Try-On|long side < 1920, face width >= 100|< 10MB|jpg/jpeg/png| * Error Codes |Error Code|Description| | ---- | ---- | |error_below_min_image_size|the size of the source image is smaller than minimum (expect: width >= 100px, height >= 100px) |error_exceed_max_image_size|the size of the source image is larger than maximum (expect: width < 1920px, height < 1080px) |error_face_position_invalid |Please ensure your entire face is fully visible within the image| |error_face_position_too_small|The detected face is too small. Move closer to the camera| |error_face_position_out_of_boundary|The face is too large or partially outside the image frame. Adjust your position| |error_face_angle_invalid|The face angle is incorrect. For front-facing photos, keep your head within 10°. For side-facing photos, ensure more than 15°.| * Environment & Dependency | Sample Code Language / Tool | Recommended Runtime Versions | |---|---| | cURL | - bash >= 3.2
- curl >= 7.58 (modern TLS/HTTP support)
- jq >= 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 | --- ## JS Camera Kit {% partial file="/_partials/js-camera-kit.md" /%} 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 Makeup Virtual Try-On](https://docs.perfectcorp.com/_bundle/reference/makeup_vto.yaml) ## V1.0 ### Create a new file. - [POST /s2s/v2.0/file/makeup-vto](https://docs.perfectcorp.com/reference/makeup_vto/v1.0/paths/~1s2s~1v2.0~1file~1makeup-vto/post.md): To upload a new file, you'll first need to use the File API. It will give you a URL – use that URL to upload your file. Once the upload is finished, you can use the file_id from the same response to start using our AI features. ### Run an AI Makeup Virtual Try On task. - [POST /s2s/v2.0/task/makeup-vto](https://docs.perfectcorp.com/reference/makeup_vto/v1.0/paths/~1s2s~1v2.0~1task~1makeup-vto/post.md): This endpoint initiates the makeup virtual try-on process. You must provide a source file (via URL or File ID) and specify the effects to apply using the defined effect schemas. The task will be processed asynchronously, and you can check its status using the task_id returned in this response. ### Check the status of a AI Makeup Virtual Try On task. - [GET /s2s/v2.0/task/makeup-vto/{task_id}](https://docs.perfectcorp.com/reference/makeup_vto/v1.0/paths/~1s2s~1v2.0~1task~1makeup-vto~1%7Btask_id%7D/get.md)