{
"openapi": "3.0.0",
"info": {
"title": "AI 膚況模擬",
"description": "# 概述\n**AI 驅動的膚況模擬：以精準與專業呈現治療進展**\n\n我們尖端的 AI 驅動膚況模擬技術，能高度準確地呈現臉部膚況的前後視覺化，讓專業人士與消費者都能客觀追蹤護膚治療隨時間的成效。此解決方案為高傳真寫實與臨床級洞察而設計，支援多達十種不同膚況問題的視覺化，包括光澤、痤瘡、油脂、眼袋、黑眼圈、斑點、毛孔、質地、皺紋與泛紅。\n\n\n\n透過結合精密的機器學習模型與先進的擴增實境能力，系統僅需一般智慧型手機鏡頭或桌面網路攝影機，即可提供潛在結果的真實、非侵入式預覽。每次模擬在數秒內生成，讓使用者立即獲得有科學根據的理解，了解針對性的護膚介入如何隨時間改善膚況。\n\n\n\n此平台專為護膚品牌、皮膚科診所、醫學美容診所與美妝零售業設計，可輕鬆整合於數位與實體接觸點，包括電子商務網站、行動應用、虛擬諮詢與銷售點自助服務機。其多元性支援廣泛的使用案例，例如個人化護膚方案推薦、產品效能模擬、專業療程的治療規劃，以及強化客戶互動並建立對品牌聲明信任的互動式教育工具。\n\n\n\n透過客觀的視覺化與數據驅動的敘事，我們的 AI 膚況模擬讓護膚專業人士能設定切合實際的期望、客製化護理計畫，並展示可衡量的進展，最終提升客戶體驗，同時在日益競爭的市場中強化有實證根據的療效。\n\n\n\n---\n\n## 整合指南\n本指南將引導您完成：\n\nAI 膚況模擬 API 的工作流程：\n\n**端點：** `/s2s/v2.0/task/skin-simulation`\n\n**需要認證：** `Authorization: Bearer YOUR_API_KEY`\n\n**工作流程步驟：**\n\n1. **圖片上傳準備：**\n - 流程從準備自拍圖片開始。\n\n2. **AI 膚況模擬設定**\n 針對每個膚況問題（例如皺紋、毛孔、泛紅），使用 **0.0 到 1.0** 的值調整**模擬強度**：\n\n - **0.0**：顯示您*原始*的肌膚外觀——無變化。\n - **1.0**：套用 AI 能針對該問題生成的*最自然、最健康外觀*的增強。\n\n **運作方式：**\n - 在低設定（例如 0.2–0.4）時，細紋或輕微瑕疵會被細微地柔化。\n - 在較高設定（例如 0.7–1.0）時，改善更明顯，例如顯著減少中度或深層皺紋、更平滑的質地與更好的膚色，同時保留自然的肌膚細節。\n\n 逐步調整以達成您想要的外觀！\n\n1. **啟動 AI 任務並取得任務 ID：**\n - 透過 HTTP POST 請求，將上傳的圖片與膚況模擬設定傳送到 `/s2s/v2.0/task/skin-simulation`。\n - 在回應中取得唯一的任務 ID，用以識別這次互動。\n\n2. **輪詢任務狀態（持續檢查）：**\n - 使用取得的 `task_id`，透過 HTTP GET 請求（例如 `GET /task/${task_id}`）定期輪詢任務狀態。\n - 持續監控：\n - `Task_status = \"success\"`（流程完成）。\n - `Task_status = \"error\"`（視情況解決或重試）。\n - 狀態轉為成功後，相應更新工作流程。\n\n這個結構化的工作流程確保與使用者輸入的高效整合、任務的自動化監控，以及無縫取得結果。\n\n---\n\n* 認證\n- 使用 **Bearer Token** 將您的 API key 納入請求標頭：\n ```\n Authorization: Bearer YOUR_API_KEY\n ```\n您可以在 https://yce.makeupar.com/api-console/en/api-keys/ 找到您的 API Key。\n\n---\n\n* 上傳圖片\n\n您可以直接上傳檔案到伺服器，或在 AI 任務內容中提供有效的圖片網址。\n\n * 上傳端點\n\n```\nPOST /s2s/v2.0/file\n```\n\n或者，若您已有公開的圖片網址，可跳過此步驟。\n\n---\n\n* 調整 AI 膚況模擬強度\n**AI 膚況模擬設定**\n\n針對每個膚況問題（例如皺紋、毛孔、泛紅），在 **0.0 到 1.0** 的尺度上調整**模擬強度**：\n\n- **0.0** → *原始外觀* — 未套用 AI 增強。\n- **1.0** → 針對該問題*最大自然、健康外觀的改善*，由我們的 AI 模型寫實地渲染。\n\n**不同強度等級的預期效果：**\n\n| 強度範圍 | 效果 |\n|-----------------|--------|\n| **0.1 – 0.3** | 細微精修—輕度柔化細紋、細微柔化毛孔，或溫和減少泛紅。最適合自然的「清新面容」。 |\n| **0.4 – 0.6** | 均衡增強—在保留個人肌膚特質的同時，質地與清晰度有明顯改善。 |\n| **0.7 – 1.0** | 完整修正—顯著減少中度到深層皺紋、均勻膚色、縮小毛孔與泛紅，並提升整體光澤—*不會*看起來過度修飾或不自然。 |\n\n**專業提示：** 從低值開始（例如 0.2），逐步提高，直到達到滿意的寫實結果。\n\n---\n\n* 建立 AI 膚況模擬任務並輪詢結果\n\n上傳圖片並設定**至少一個**膚況問題的模擬強度高於 0.0 後，即可啟動任務。API 以非同步方式處理請求。您必須輪詢任務狀態，直到達到 `success` 或 `error`。\n\n * 建立任務端點\n\n```\nPOST /s2s/v2.0/task/skin-simulation\n```\n\n * 輪詢端點\n\n```\nGET /s2s/v2.0/task/skin-simulation/{task_id}\n```\n\n---\n\n## 檔案規格與錯誤\n\n* AI 膚況模擬規範\n\n**攝影與影像指引**\n\n**光線條件**\n確保環境光線充足且均勻照明。避免強逆光、局部過度曝光，或臉上出現大片陰影。盡可能使用自然日光或柔和的室內光線。不要使用有色光，包括粉色、藍色或其他帶色調的光源，因為它們可能扭曲膚色的呈現。\n\n**臉部位置與遮擋**\n拍攝正對鏡頭的正面視角。頭部旋轉應盡量小；避免過度傾斜或轉向兩側。確保整張臉，包括額頭、臉頰與下巴，完全可見且無遮擋。不要使用頭髮、口罩、手、眼鏡框、手機，或其他部分覆蓋臉部特徵的物件。\n\n**臉部表情與姿勢**\n保持自然、放鬆的表情，雙眼睜開。嘴巴可保持閉合或略微張開，不要勉強或誇張姿勢。\n\n**臉部在畫面中的尺寸**\n臉部必須佔圖片寬度的至少 60%，以確保有足夠細節供精準分析。避免拍攝過小、過遠，或構圖不當的主體。\n\n\n\n\n---\n\n* 支援的格式與尺寸\n\n|AI 功能|支援的尺寸|支援的檔案大小|支援的格式|\n| ---- | ---- | ---- | ---- |\n|AI 膚況模擬|短邊 >= 480，長邊 <= 2560|< 10MB|jpg/jpeg/png|\n\n* 錯誤代碼\n\n| **錯誤代碼** | **說明** |\n|------------------------------------|----------------|\n| `error_below_min_image_size` | 輸入圖片解析度低於最小要求尺寸（例如 < 256×256 像素）。請上傳更高解析度的圖片。 |\n| `error_exceed_max_image_size` | 輸入圖片解析度超過允許的最大尺寸（例如 > 2560×2560 像素）。請在上傳前調整或縮小圖片。 |\n| `error_invalid_params` | 提供了無效的請求參數。 |\n| `error_src_face_too_small` | 偵測到的臉部佔圖片寬度不到 60%——太小，無法進行精準的肌膚檢測。請使用臉部更大、更清晰且位於畫面中央的圖片。 |\n| `error_src_face_out_of_bound` | 偵測到的臉部部分或完全在圖片邊界之外（例如臉部裁切過緊）。請確保完整臉部——包括額頭、臉頰與下巴——可見且構圖得當。 |\n| `error_lighting_dark` | 影像中的環境光線不足以進行可靠的肌膚檢測（例如曝光不足、陰影主導臉部）。請上傳在光線充足條件下拍攝、臉部照明均勻的圖片。 |\n\n\n* 環境與相依性\n\n| 範例程式語言 / 工具 | 建議的執行環境版本 |\n|---|---|\n| cURL | - bash >= 3.2 - curl >= 7.58（現代 TLS/HTTP 支援） - jq >= 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## JS Camera Kit\n{% partial file=\"/_partials/js-camera-kit.md\" /%}\n\n---\n\n## 點數消耗\n\n* 膚況模擬\n\n| AI 功能 | 消耗的點數 |\n|---|---|\n| 1~4 項分析 | 4 |\n| 5~10 項分析 | 6 |\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": "V1.0",
"description": "使用 AI 處理，在上傳的圖片模擬肌膚質地變化（皺紋、光澤、油脂等）。"
}
],
"paths": {
"/s2s/v2.0/task/skin-simulation": {
"post": {
"summary": "執行 AI 膚況模擬任務。",
"description": "這個端點啟動膚況模擬流程。您必須提供來源檔案（透過網址或檔案 ID），並指定模擬參數（皺紋、光澤等）。至少有一個參數不能為零。任務會以非同步方式處理，您可以使用這個回應回傳的 task_id 查詢其狀態。\n",
"tags": [
"V1.0"
],
"security": [
{
"BearerAuthenticationV2": []
}
],
"requestBody": {
"required": true,
"description": "模擬強度不可全為零。\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunSkinSimulationTaskV2"
}
}
}
},
"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/skin-simulation/{task_id}": {
"get": {
"summary": "查詢 AI 膚況模擬任務的狀態。",
"tags": [
"V1.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": {
"RunSkinSimulationTaskV2": {
"title": "執行膚況模擬任務 V2",
"allOf": [
{
"$ref": "#/components/schemas/BasicRunTaskV2"
},
{
"type": "object",
"properties": {
"wrinkle": {
"type": "number",
"description": "減少皺紋與細紋的外觀，同時恢復更平滑、更緊實、明顯回春與年輕的肌膚。
0.0 為原始肌膚，1.0 為去除最多皺紋的肌膚。",
"example": 1,
"minimum": 0,
"maximum": 1
},
"radiance": {
"type": "number",
"description": "提升肌膚光澤與明亮度，展現清新、充滿活力的光采與更明亮、更有光澤的膚色。
0.0 為原始肌膚亮度，1.0 為最大光澤／發光的肌膚。",
"example": 1,
"minimum": 0,
"maximum": 1
},
"oiliness": {
"type": "number",
"description": "控制多餘的油光，呈現清新、乾淨、無油光的膚色，帶來平衡且舒適的霧面感。
0.0 為原始肌膚，1.0 為加入最多油脂／油光的肌膚。",
"example": 1,
"minimum": 0,
"maximum": 1
},
"acne": {
"type": "number",
"description": "透過減少痘痘與黑頭粉刺，淨化易長粉刺的肌膚，呈現更平滑、細緻、明顯無瑕且光澤的膚色。
0.0 為原始肌膚，1.0 為去除最多痤瘡／粉刺的肌膚。",
"example": 1,
"minimum": 0,
"maximum": 1
},
"eye_bags": {
"type": "number",
"description": "明顯減少眼下浮腫，恢復更平滑、更緊實、更有精神、充分休息的外觀。
0.0 為原始眼下外觀，1.0 為去除最多眼袋。",
"example": 1,
"minimum": 0,
"maximum": 1
},
"dark_circle": {
"type": "number",
"description": "明顯減淡黑眼圈，呈現更明亮、充分休息的眼周，外觀清新且有光澤。
0.0 為原始眼下顏色，1.0 為去除最多黑眼圈。",
"example": 1,
"minimum": 0,
"maximum": 1
},
"spots": {
"type": "number",
"description": "針對老化斑並明顯淡化，同時提升肌膚清晰度，呈現更平滑、更均勻的年輕光采。
0.0 為原始肌膚，1.0 為去除最多老化斑／瑕疵。",
"example": 1,
"minimum": 0,
"maximum": 1
},
"pores": {
"type": "number",
"description": "細緻並明顯縮小粗大毛孔，呈現更平滑、更精緻、完美細緻的肌膚。
0.0 為原始毛孔可見度，1.0 為最細緻／幾乎看不見的毛孔。",
"example": 1,
"minimum": 0,
"maximum": 1
},
"texture": {
"type": "number",
"description": "將肌膚質地精修至高級訂製級的平滑度，明顯改善不平處，呈現絲滑、完美打磨且光澤的膚色。
0.0 為原始肌膚質地，1.0 為最平滑的肌膚質地。",
"example": 1,
"minimum": 0,
"maximum": 1
},
"redness": {
"type": "number",
"description": "明顯減少泛紅、舒緩易患酒糟性皮膚炎的區域，恢復更清澈、更均勻、舒適精修的膚色，讓敏感肌膚平靜並重新平衡。
0.0 為原始膚色，1.0 為去除最多泛紅／刺激。",
"example": 1,
"minimum": 0,
"maximum": 1
}
},
"not": {
"properties": {
"wrinkle": {
"type": "number",
"enum": [
0
]
},
"radiance": {
"type": "number",
"enum": [
0
]
},
"oiliness": {
"type": "number",
"enum": [
0
]
},
"acne": {
"type": "number",
"enum": [
0
]
},
"eye_bags": {
"type": "number",
"enum": [
0
]
},
"dark_circle": {
"type": "number",
"enum": [
0
]
},
"spots": {
"type": "number",
"enum": [
0
]
},
"pores": {
"type": "number",
"enum": [
0
]
},
"texture": {
"type": "number",
"enum": [
0
]
},
"redness": {
"type": "number",
"enum": [
0
]
}
}
}
}
]
},
"BasicRunTaskV2SrcFileUrl": {
"type": "object",
"required": [
"src_file_url"
],
"properties": {
"src_file_url": {
"type": "string",
"description": "要執行任務的檔案網址。該網址應可公開存取。",
"example": "https://example.com/selfie.jpg"
}
}
},
"BasicRunTaskV2SrcFileId": {
"type": "object",
"required": [
"src_file_id"
],
"properties": {
"src_file_id": {
"type": "string",
"description": "要執行任務的檔案 ID。檔案 ID 來自上傳檔案 API。",
"example": "pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
}
}
},
"BasicRunTaskV2": {
"title": "BasicRunTaskV2",
"anyOf": [
{
"title": "Run task with src file url",
"allOf": [
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileUrl"
}
]
},
{
"title": "Run task with src file ID",
"allOf": [
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileId"
}
]
}
]
},
"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"
}
}
}
}
}
}
}
}
}