檔案規格與錯誤

AI 虛擬帽子

概述

透過我們由尖端 AI 技術驅動的極其逼真 AR 頭飾試戴，步入時尚的未來。這創新的解決方案將線上購物轉變為沉浸式體驗，讓顧客以無與倫比的精準度與真實感虛擬試戴頭飾。從即時的風格發現到栩栩如生的視覺呈現，我們的 AR 技術確保每頂帽子與髮帶看起來與感覺都真實。幫助購物者在購買前找到完美的尺寸與風格。提升互動、增強信心，並重新定義顧客與您產品互動的方式。

整合指南

本指南將引導您完成：

端點： /s2s/v2.0/task/hat
認證： 所有請求都需要 Authorization: Bearer YOUR_API_KEY
工作流程：
1. 準備自拍圖片： 上傳圖片，或提供您本人的有效圖片網址作為虛擬試戴目標。
2. 準備帽子圖片： 上傳帽子產品圖片，或戴帽子的人物照片。
3. 選擇風格與性別： 選擇您偏好的風格，以及您希望呈現的性別。
4. 啟動 AI 任務並取得任務 ID： 從回應中取得 task_id。
5. 輪詢狀態（GET）： 使用 task_id 查詢任務狀態。持續輪詢，直到 task_status 為 "success" 或 "error"。

認證

使用 Bearer Token 將您的 API key 納入請求標頭：

Authorization: Bearer YOUR_API_KEY

您可以在 https://yce.makeupar.com/api-console/en/api-keys/ 找到您的 API Key。

AI 帽子 API 使用指南

本指南說明如何使用 AI 帽子 API 上傳圖片、準備參考帽子，以及建立虛擬試戴任務。

步驟 1. 準備自拍圖片

您可以：

使用 File API（/s2s/v2.0/file）上傳自拍圖片，或
提供有效的圖片網址。
- 步驟 1.1 使用 File API 上傳檔案

使用 File API（/s2s/v2.0/file）上傳目標使用者圖片。

圖片需求：

上傳一張自拍照片。
確保照片清楚呈現上半身。
避免有多人干擾的物件背景。

請求範例：

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
      }
    ]
  }'

步驟 1.2. 取得 File API 回應

回應包含：

用於建立 AI 任務的 file_id。
用於上傳實際圖片檔案的 requests.url。

回應範例：

{
  "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"
            }
          }
        ]
      }
    ]
  }
}

步驟 1.3. 上傳圖片到提供的網址

使用 File API 回應中的 requests.url 上傳圖片：

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'

步驟 2. 準備參考帽子圖片

您可以：

使用 File API（/s2s/v2.0/file）上傳帽子圖片，或
提供有效的圖片網址。

支援的帽子圖片：

帽子產品圖片。
戴帽子的人物照片。

詳細規格請參考 檔案規格與錯誤。

步驟 3. 建立 AI 任務

選擇您偏好的風格，以及您希望呈現的性別。使用 AI 任務 API（/s2s/v2.0/task/hat）建立虛擬試戴任務。

參數：

使用者圖片：src_file_id 或 src_file_url。
帽子圖片：ref_file_id 或 ref_file_url。

請求範例：

curl --request POST \
  --url https://yce-api-01.makeupar.com/s2s/v2.0/task/hat \
  --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"
}'

回應範例：

{
  "status": 200,
  "data": {
    "task_id": "SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT"
  }
}

步驟 4. 輪詢任務結果

使用任務 ID 查詢狀態：

curl --request GET \
  --url https://yce-api-01.makeupar.com/s2s/v2.0/task/hat/SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'content-type: application/json'

步驟 5. 取得結果

成功的回應會包含結果圖片的下載網址：

{
  "status": 200,
  "data": {
    "error": null,
    "results": {
      "url": "https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature..."
    },
    "task_status": "success"
  }
}

API Key 無效的錯誤回應：

{
  "status": 401,
  "error": "Unauthorized",
  "error_code": "InvalidAccessToken"
}

檔案規格與錯誤

AI 虛擬帽子規範
- 圖片需求

類型	最低解析度	備註
自拍	512 × 512	臉部可見，建議頭到胸
帽子	512 × 512（產品） 800 × 800（佩戴）	清晰、無遮擋的帽子視角

支援的帽子圖片

產品圖片需求
- 最低解析度：512 × 512 像素
- 每張圖片僅限一個產品
- 產品應覆蓋圖片高度的 25% 以上

佩戴圖片需求
- 最低解析度：800 × 800 像素
- 單件物品要求：模特必須佩戴恰好一件物品。不可有多件物品或配件。
- 覆蓋比例：佩戴的物品必須佔整體圖片高度的 20% 以上。這確保物品在畫面中清晰可見且突出。

支援的自拍視角

建議圖片解析度：至少 512 × 512 像素。
建議臉部覆蓋範圍：超過圖片高度的 15%。
單人主體要求：圖片必須包含恰好一位人物主體。不可有額外人物或局部身影。
臉部可見性：主體的臉部必須完全可見且無遮擋。頭髮、配件或物件不應覆蓋關鍵臉部特徵。
構圖：圖片至少需包含半身頭像，涵蓋從頭頂到胸部區域。為獲得最佳分析效果，建議使用半身照（頭到腰）。

試戴風格

共有五種預先定義的風格用於生成虛擬試戴輸出："style_sporty_casual"、"style_urban_fashion"、"style_vacation_casual"、"style_warm_cozy" 與 "style_bohemian"。您可以在建立 AI 任務時指定此風格參數，或讓系統預設隨機選擇風格。

style_vacation_casual

支援的格式與尺寸

AI 功能	支援的尺寸	支援的檔案大小	支援的格式
AI 虛擬帽子	輸入：長邊 <= 4096 輸出：896 x 1152	< 10MB	jpg/jpeg/png/heic

錯誤代碼

錯誤代碼	說明
error_download_image	下載來源或參考圖片失敗
error_inference	推論流程錯誤
error_no_face	來源圖片未偵測到臉部
error_nsfw_content_detected	在結果中偵測到 NSFW 內容
exceed_max_filesize	檔案大小超過 10 MB
invalid_parameter	性別或風格值無效
unknown_internal_error	其他內部錯誤

環境與相依性

範例程式語言 / 工具	建議的執行環境版本
cURL	- bash >= 3.2 - curl >= 7.58（現代 TLS/HTTP 支援） - jquery >= 1.6（穩健的 JSON 解析）
Node.js（JavaScript）	Node >= 18（支援全域 fetch）
JavaScript	- Chrome / Edge >= 80 - Firefox >= 74 - Safari >= 13.1
PHP	PHP >= 7.4（現代 TLS/相容性），ext-curl（建議）或 allow_url_fopen=On + ext-openssl、ext-json
Python	Python >= 3.10（支援 f-strings），requests >= 2.20.0
Java	Java 11+（支援 HttpClient），Jackson Databind >= 2.12.0

點數消耗

AI 功能	消耗的點數
AI 虛擬帽子 V2.0	2

下载 OpenAPI 描述

ai_hat.json

ai_hat.yaml

概述

电子邮件

YouCamOnlineEditor_API@perfectcorp.com

许可证

服务条款

语言

服务器

https://yce-api-01.makeupar.com