{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-@l10n/zh-TW/reference/ai_scarf.yaml","sidebar":"sidebar-@l10n/zh-TW/reference/sidebars.yaml"},"props":{"definitionId":"@l10n/zh-TW/reference/ai_scarf.yaml","settings":{"baseUrlPath":"/zh-tw/reference/ai_scarf"},"disableAutoScroll":true,"seo":{"title":"AI 虛擬試圍巾","description":"YouCam API documentation by Perfect Corp. Learn how to use Skin analysis API, Virtual try-on API, Image editing API, and Video generative AI APIs.","siteUrl":"https://docs.perfectcorp.com","keywords":"AI Skin Analysis, AI Clothes, AI Hairstyle, AI Outfits","image":"/assets/favicon.cd6fa4d833b2a573b3c6dae68386b293da205b203402cb0c97b80bd2acc07ea2.8351e24f.png"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"AI 虛擬試圍巾","version":"","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（產品）<br>800 × 800（佩戴） | 清晰、無遮擋的圍巾視角 |\n\n**支援的圍巾圖片**\n\n* 產品圖片需求\n    * 最低解析度：512 × 512 像素\n    * 每張圖片僅限一個產品\n    * 產品應覆蓋圖片高度的 25% 以上\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/021_thumb_e356d121b3.jpg)\n\n* 佩戴圖片需求\n    * 最低解析度：800 × 800 像素\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/008_thumb_5dd8b1be93.jpg)\n\n**支援的自拍視角**\n\n* 建議圖片解析度：至少 512 × 512 像素。\n* 建議臉部覆蓋範圍：超過圖片高度的 15%。\n* 圖片必須清楚呈現單一人物主體，臉部完全可見，且畫面至少包含從頭到胸的半身照。建議使用半身照。\n\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/lashana_lynch_thumb_7a900b811e.jpg)\n\n**試戴風格**\n\n* 共有五種預先定義的風格用於生成虛擬試戴輸出：\"style_french_elegance\"、\"style_light_luxury\"、\"style_cottagecore\"、\"style_modern_chic\" 與 \"style_bohemian\"。您可以在建立 AI 任務時指定此風格參數，或讓系統預設隨機選擇風格。\n\n![style_french_elegance](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/3d88ad75_41ca_4bf8_b81d_f52adf5db263_4a06b3e174.jpg)\n\n---\n\n* 支援的格式與尺寸\n\n|AI 功能|支援的尺寸|支援的檔案大小|支援的格式|\n|  ----  | ----  | ----  | ----  |\n|AI 虛擬試圍巾|輸入：長邊 <= 4096 <br>輸出：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</br>   - curl >= 7.58（現代 TLS/HTTP 支援）</br>   - jquery >= 1.6（穩健的 JSON 解析） |\n| Node.js（JavaScript） | Node >= 18（支援全域 fetch） |\n| JavaScript | - Chrome / Edge >= 80</br>   - Firefox >= 74</br>   - 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"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.perfectcorp.com","port":4000,"ipAddress":"216.73.217.126"},"lang":"zh-TW","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/zh-tw/reference/ai_scarf","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}