{
"openapi": "3.0.0",
"info": {
"title": "AI 虛擬試圍巾",
"description": "# 概述\n透過線上 AR 圍巾虛擬試戴，提升您的時尚體驗。購物者可即刻將圍巾披掛在穿搭上，看見圖案在現實中的流動感。\n這互動式的虛擬圍巾功能讓顧客在線上探索不同風格與顏色，重現店內購物體驗。由高傳真 AR 模擬驅動，使用者隨時隨地都能享受細緻的圍巾視覺化。\n\n## 整合指南\n本指南將引導您完成：\n\n* **端點：** `/s2s/v2.0/task/scarf`\n* **認證：** 所有請求都需要 `Authorization: Bearer YOUR_API_KEY`\n* **工作流程：**\n 1. **準備自拍圖片：** 上傳圖片，或提供您本人的有效圖片網址作為虛擬試戴目標。\n 1. **準備圍巾圖片：** 上傳圖片，或提供圍巾產品、或清楚可見且無遮擋地圍著圍巾的人物之有效圖片網址。\n 1. **選擇風格與性別：** 選擇您偏好的風格，以及您希望呈現的性別。\n 1. **啟動 AI 任務並取得任務 ID：** 從回應中取得 `task_id`。\n 1. **輪詢狀態（`GET`）：** 使用 `task_id` 查詢任務狀態。持續輪詢，直到 `task_status` 為 `\"success\"` 或 `\"error\"`。\n\n---\n\n* 認證\n- 使用 **Bearer Token** 將您的 API key 納入請求標頭：\n```\nAuthorization: Bearer YOUR_API_KEY\n```\n您可以在 https://yce.makeupar.com/api-console/en/api-keys/ 找到您的 API Key。\n\n---\n\n* AI 虛擬試圍巾 API 使用指南\n\n本指南說明如何使用 AI 虛擬試圍巾 API 上傳圖片、準備參考圍巾，以及建立虛擬試戴任務。\n\n***\n\n * 步驟 1. 準備自拍圖片\n\n您可以：\n* 使用 File API（`/s2s/v2.0/file`）上傳自拍圖片，或\n* 提供有效的圖片網址。\n\n * 步驟 1.1 使用 File API 上傳檔案\n\n使用 **File API**（`/s2s/v2.0/file`）上傳目標使用者圖片。\n\n**圖片需求：**\n\n* 上傳一張自拍照片。\n* 確保照片清楚呈現上半身。\n* 避免有多人干擾的物件背景。\n\n**請求範例：**\n\n```bash\ncurl --request POST \\\n --url https://yce-api-01.makeupar.com/s2s/v2.0/file \\\n --header 'Authorization: Bearer YOUR_API_KEY' \\\n --header 'content-type: application/json' \\\n --data '{\n \"files\": [\n {\n \"content_type\": \"image/jpg\",\n \"file_name\": \"selfie_photo_01_3dbd1b6683.jpg\",\n \"file_size\": 547541\n }\n ]\n }'\n```\n\n***\n\n * 步驟 1.2. 取得 File API 回應\n\n回應包含：\n\n* 用於建立 AI 任務的 `file_id`。\n* 用於上傳實際圖片檔案的 `requests.url`。\n\n**回應範例：**\n\n```json\n{\n \"status\": 200,\n \"data\": {\n \"files\": [\n {\n \"content_type\": \"image/jpg\",\n \"file_name\": \"selfie_photo_01_3dbd1b6683.jpg\",\n \"file_id\": \"SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9/13W5TOD8/u/FfjK3xgCQ+hRt9MJXBFaud\",\n \"requests\": [\n {\n \"method\": \"PUT\",\n \"url\": \"https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...\",\n \"headers\": {\n \"Content-Length\": \"547541\",\n \"Content-Type\": \"image/jpg\"\n }\n }\n ]\n }\n ]\n }\n}\n```\n\n***\n\n * 步驟 1.3. 上傳圖片到提供的網址\n\n使用 File API 回應中的 `requests.url` 上傳圖片：\n\n```bash\ncurl --location --request PUT 'https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...' \\\n --header 'Content-Type: image/jpg' \\\n --header 'Content-Length: 547541' \\\n --data-binary @'./selfie_photo_01_3dbd1b6683.jpg'\n```\n\n***\n\n * 步驟 2. 準備參考圍巾圖片\n\n您可以：\n\n* 使用 File API（`/s2s/v2.0/file`）上傳圍巾圖片，或\n* 提供有效的圖片網址。\n\n**支援的圍巾圖片：**\n\n* 圍巾的產品圖片。\n* 無遮擋地圍著圍巾的人物，作為圍巾參考。\n\n詳細規格請參考 **[檔案規格與錯誤](#section/overview/File-Specs-and-Errors)**。\n\n***\n\n * 步驟 3. 建立 AI 任務\n\n選擇您偏好的風格，以及您希望呈現的性別。\n使用 **AI 任務 API**（`/s2s/v2.0/task/scarf`）建立虛擬試戴任務。\n\n**參數：**\n\n* 使用者圖片：`src_file_id` 或 `src_file_url`。\n* 圍巾圖片：`ref_file_id` 或 `ref_file_url`。\n\n**請求範例：**\n\n```bash\ncurl --request POST \\\n --url https://yce-api-01.makeupar.com/s2s/v2.0/task/scarf \\\n --header 'Authorization: Bearer YOUR_API_KEY' \\\n --header 'content-type: application/json' \\\n --data '{\n \"src_file_url\": \"https://example.com/selfie.jpg\",\n \"ref_file_url\": \"https://example.com/accessory.jpg\",\n \"gender\": \"female\",\n \"style\": \"random\"\n}'\n```\n\n**回應範例：**\n\n```json\n{\n \"status\": 200,\n \"data\": {\n \"task_id\": \"SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT\"\n }\n}\n```\n\n***\n\n * 步驟 4. 輪詢任務結果\n\n使用任務 ID 查詢狀態：\n\n```bash\ncurl --request GET \\\n --url https://yce-api-01.makeupar.com/s2s/v2.0/task/scarf/SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT \\\n --header 'Authorization: Bearer YOUR_API_KEY' \\\n --header 'content-type: application/json'\n```\n\n***\n\n * 步驟 5. 取得結果\n\n成功的回應會包含結果圖片的下載網址：\n\n```json\n{\n \"status\": 200,\n \"data\": {\n \"error\": null,\n \"results\": {\n \"url\": \"https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...\"\n },\n \"task_status\": \"success\"\n }\n}\n```\n\nAPI Key 無效的錯誤回應：\n\n```json\n{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"error_code\": \"InvalidAccessToken\"\n}\n```\n\n---\n\n## 檔案規格與錯誤\n\n* AI 虛擬試圍巾規範\n\n * 圖片需求\n\n| 類型 | 最低解析度 | 備註 |\n| ------ | ------------------ | ----- |\n| 自拍 | 512 × 512 | 臉部可見，建議頭到胸 |\n| 圍巾 | 512 × 512（產品）
800 × 800（佩戴） | 清晰、無遮擋的圍巾視角 |\n\n**支援的圍巾圖片**\n\n* 產品圖片需求\n * 最低解析度：512 × 512 像素\n * 每張圖片僅限一個產品\n * 產品應覆蓋圖片高度的 25% 以上\n\n\n\n* 佩戴圖片需求\n * 最低解析度：800 × 800 像素\n\n\n\n**支援的自拍視角**\n\n* 建議圖片解析度：至少 512 × 512 像素。\n* 建議臉部覆蓋範圍：超過圖片高度的 15%。\n* 圖片必須清楚呈現單一人物主體，臉部完全可見，且畫面至少包含從頭到胸的半身照。建議使用半身照。\n\n\n\n**試戴風格**\n\n* 共有五種預先定義的風格用於生成虛擬試戴輸出：\"style_french_elegance\"、\"style_light_luxury\"、\"style_cottagecore\"、\"style_modern_chic\" 與 \"style_bohemian\"。您可以在建立 AI 任務時指定此風格參數，或讓系統預設隨機選擇風格。\n\n\n\n---\n\n* 支援的格式與尺寸\n\n|AI 功能|支援的尺寸|支援的檔案大小|支援的格式|\n| ---- | ---- | ---- | ---- |\n|AI 虛擬試圍巾|輸入：長邊 <= 4096
輸出：896 x 1152 |< 10MB|jpg/jpeg/png/heic|\n\n* 錯誤代碼\n\n| 錯誤代碼 | 說明 |\n| ------------------------------ | -------------------------------------------- |\n| error\\_download\\_image | 下載來源或參考圖片失敗 |\n| error\\_inference | 推論流程錯誤 |\n| error\\_no\\_face | 來源圖片未偵測到臉部 |\n| error\\_nsfw\\_content\\_detected | 在結果中偵測到 NSFW 內容 |\n| exceed\\_max\\_filesize | 檔案大小超過 10 MB |\n| invalid\\_parameter | 性別或風格值無效 |\n| unknown\\_internal\\_error | 其他內部錯誤 |\n\n\n* 環境與相依性\n\n| 範例程式語言 / 工具 | 建議的執行環境版本 |\n|---|---|\n| cURL | - bash >= 3.2 - curl >= 7.58（現代 TLS/HTTP 支援） - jquery >= 1.6（穩健的 JSON 解析） |\n| Node.js（JavaScript） | Node >= 18（支援全域 fetch） |\n| JavaScript | - Chrome / Edge >= 80 - Firefox >= 74 - Safari >= 13.1 |\n| PHP | PHP >= 7.4（現代 TLS/相容性），ext-curl（建議）或 allow_url_fopen=On + ext-openssl、ext-json |\n| Python | Python >= 3.10（支援 f-strings），requests >= 2.20.0 |\n| Java | Java 11+（支援 HttpClient），Jackson Databind >= 2.12.0 |\n\n---\n\n## 點數消耗\n\n| AI 功能 | 消耗的點數 |\n|---|---|\n| AI 虛擬試圍巾 V2.0 | 2 |\n\n---\n",
"version": "",
"termsOfService": "https://www.makeupar.com/perfectbeauty/youcam/terms-of-service-api",
"contact": {
"email": "YouCamOnlineEditor_API@perfectcorp.com"
},
"license": {
"name": "Privacy policy",
"url": "https://www.makeupar.com/perfectbeauty/youcam/privacy-policy-api"
}
},
"servers": [
{
"url": "https://yce-api-01.makeupar.com"
}
],
"tags": [
{
"name": "V2.0",
"description": "使用 AI 處理，為上傳的圖片生成圍巾虛擬試戴體驗，支援控制穿搭與背景的風格參數。"
}
],
"paths": {
"/s2s/v2.0/task/scarf": {
"post": {
"summary": "執行 AI 虛擬試圍巾任務。",
"description": "這個端點啟動圍巾虛擬試戴流程。您必須提供來源檔案、參考檔案（網址或 ID），並指定性別與風格參數。任務會以非同步方式處理，您可以使用這個回應回傳的 task_id 查詢其狀態。\n",
"tags": [
"V2.0"
],
"security": [
{
"BearerAuthenticationV2": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GenderRunTaskV2"
},
{
"type": "object",
"properties": {
"style": {
"type": "string",
"enum": [
"random",
"style_french_elegance",
"style_light_luxury",
"style_cottagecore",
"style_modern_chic",
"style_bohemian"
],
"default": "random",
"description": "用於控制穿搭與背景風格。",
"example": "random"
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "任務執行成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BasicRunTaskResponseV2"
}
}
}
},
"400": {
"description": "任務執行失敗",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RunError"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/InvalidApiKey"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
}
}
},
"/s2s/v2.0/task/scarf/{task_id}": {
"get": {
"summary": "查詢 AI 虛擬試圍巾任務的狀態。",
"tags": [
"V2.0"
],
"security": [
{
"BearerAuthenticationV2": []
}
],
"parameters": [
{
"name": "task_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe"
},
"description": "要查詢的任務 ID"
}
],
"responses": {
"200": {
"description": "成功查詢任務狀態",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStatusResponseV2"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidTaskId"
},
"401": {
"$ref": "#/components/responses/InvalidApiKey"
},
"500": {
"$ref": "#/components/responses/TaskTimeout"
}
}
}
}
},
"components": {
"securitySchemes": {
"BearerAuthenticationV2": {
"type": "http",
"scheme": "bearer",
"description": "使用標準的 'Bearer authentication'。請在標頭中放入您的 'API Key'：`Authorization:Bearer YOUR_API_KEY`。請注意 'Bearer' 與 'YOUR_API_KEY' 之間有一個空格。"
}
},
"schemas": {
"BasicRunTaskV2SrcFileUrl": {
"type": "object",
"required": [
"src_file_url"
],
"properties": {
"src_file_url": {
"type": "string",
"description": "要執行任務的檔案網址。該網址應可公開存取。",
"example": "https://example.com/selfie.jpg"
}
}
},
"BasicRunTaskV2RefFileUrl": {
"type": "object",
"properties": {
"ref_file_url": {
"type": "string",
"description": "執行任務所用參考檔案的網址。該網址需可公開存取。",
"example": "https://example.com/accessory.jpg"
}
}
},
"BasicRunTaskV2RefFileId": {
"type": "object",
"properties": {
"ref_file_id": {
"type": "string",
"description": "執行任務所用參考檔案的 ID。來自上傳檔案 API 的檔案 ID。",
"example": "pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
}
}
},
"BasicRunTaskV2SrcFileId": {
"type": "object",
"required": [
"src_file_id"
],
"properties": {
"src_file_id": {
"type": "string",
"description": "要執行任務的檔案 ID。檔案 ID 來自上傳檔案 API。",
"example": "pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
}
}
},
"BasicRunTaskV2WithRequiredRef": {
"title": "BasicRunTaskV2WithRef",
"anyOf": [
{
"allOf": [
{
"title": "Run task with src file url & ref file url",
"required": [
"ref_file_url"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileUrl"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2RefFileUrl"
}
]
},
{
"allOf": [
{
"title": "Run task with src file url & ref file ID",
"required": [
"ref_file_id"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileUrl"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2RefFileId"
}
]
},
{
"allOf": [
{
"title": "Run task with src file ID & ref file url",
"required": [
"ref_file_url"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileId"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2RefFileUrl"
}
]
},
{
"allOf": [
{
"title": "Run task with src file ID & ref file ID",
"required": [
"ref_file_id"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileId"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2RefFileId"
}
]
}
]
},
"GenderRunTaskV2": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRunTaskV2WithRequiredRef"
},
{
"type": "object",
"required": [
"gender"
],
"properties": {
"gender": {
"type": "string",
"enum": [
"female",
"male"
],
"description": "圖片中人物的性別。",
"example": "female"
}
}
}
]
},
"BasicRunTaskResponseV2": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "回應狀態",
"example": 200
},
"data": {
"type": "object",
"properties": {
"task_id": {
"type": "string",
"description": "這個任務的 ID。任務結果可以此 ID 查詢，有效期限 24 小時。",
"example": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe"
}
}
}
}
},
"RunError": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "回應狀態",
"example": 400
},
"error": {
"type": "string",
"description": "錯誤訊息",
"example": "The operation could not be completed"
},
"error_code": {
"type": "string",
"enum": [
"InvalidParameters",
"CreditInsufficiency",
"InvalidStyleGroup",
"InvalidStyle",
"BadRequest"
],
"description": "錯誤代碼：\n* InvalidParameters - 請求參數無效\n* CreditInsufficiency - 點數不足，無法執行\n* BadRequest - 非預期的請求參數\n* InvalidStyleGroup - 風格群組 id 無效\n* InvalidStyle - 風格 id 無效\n"
}
}
},
"EngineErrorCode": {
"type": "string",
"nullable": true,
"enum": [
"error_exceed_max_image_size",
"exceed_max_filesize",
"invalid_parameter",
"error_download_image",
"error_download_mask",
"error_decode_image",
"error_decode_mask",
"error_nsfw_content_detected",
"error_no_face",
"error_pose",
"error_face_parsing",
"error_inference",
"exceed_nsfw_retry_limits",
"error_upload",
"unknown_internal_error"
],
"description": "錯誤：\n- \\`error_exceed_max_image_size\\` - 輸入圖片尺寸超過上限\n- \\`exceed_max_filesize\\` - 輸入檔案大小超過上限\n- \\`invalid_parameter\\` - 參數值無效\n- \\`error_download_image\\` - 下載來源圖片錯誤\n- \\`error_download_mask\\` - 下載遮罩圖片錯誤\n- \\`error_decode_image\\` - 解析來源圖片錯誤\n- \\`error_decode_mask\\` - 解析遮罩圖片錯誤\n- \\`error_nsfw_content_detected\\` - 在來源圖片中偵測到 NSFW 內容\n- \\`error_no_face\\` - 來源圖片未偵測到臉部\n- \\`error_pose\\` - 無法偵測來源圖片的姿势\n- \\`error_face_parsing\\` - 無法對來源圖片進行臉部分割\n- \\`error_inference\\` - 推論流程錯誤\n- \\`exceed_nsfw_retry_limits\\` - 超過重試上限以避免產生 NSFW 圖片\n- \\`error_upload\\` - 上傳結果圖片錯誤\n- \\`unknown_internal_error\\` - 其他"
},
"TaskStatusResponseBodySingleUrlResultsV2": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "下載這個結果的網址。有效期限 2 小時",
"example": "https://example.com/sample-result-url"
}
}
},
"TaskStatusResponseV2": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "回應狀態",
"example": 200
},
"data": {
"type": "object",
"properties": {
"task_status": {
"type": "string",
"enum": [
"running",
"success",
"error"
],
"description": "這個任務的狀態"
},
"error": {
"$ref": "#/components/schemas/EngineErrorCode"
},
"error_message": {
"type": "string",
"description": "錯誤的詳細說明"
},
"results": null
}
}
},
"$ref": "#/components/schemas/TaskStatusResponseBodySingleUrlResultsV2"
}
},
"responses": {
"InvalidApiKey": {
"description": "API 金鑰無效或缺失",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 401,
"description": "回應狀態"
},
"error": {
"type": "string",
"example": "Invalid API key"
}
}
}
}
}
},
"TooManyRequests": {
"description": "請求過多",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 429,
"description": "回應狀態"
},
"error": {
"type": "string",
"example": "Too many requests"
}
}
}
}
}
},
"InvalidTaskId": {
"description": "任務 ID 無效",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 400,
"description": "回應狀態"
},
"error": {
"type": "string",
"example": "Invalid task ID"
}
}
}
}
}
},
"TaskTimeout": {
"description": "任務執行逾時",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 500,
"description": "回應狀態"
},
"error": {
"type": "string",
"example": "Task execution timed out"
}
}
}
}
}
}
}
}
}