{
"openapi": "3.0.0",
"info": {
"title": "AI 牙齒美白",
"description": "# 概述\n**AI 牙齒美白 API**\n\nAI 牙齒美白 API 提供先進的自動化解決方案，用於提升照片中笑容的品質。透過智慧影像處理，它自然且精確地讓牙齒變亮，在數秒內創造精緻、專業的結果。\n\n\n\n\n\n\n**它如何移除照片中的黃牙**\n\n**智慧美白** \nAPI 自動偵測牙齒並套用自然的外觀美白效果，不會讓影像看起來不自然。\n\n**可調整的等級** \n內建的調整功能讓使用者控制美白的程度，從細微的變化到更明顯、適合上鏡的妝效。\n\n\n\n**主要功能**\n\n**快速簡易的增強** \n在數秒內獲得明顯更明亮的笑容。\n\n**精準的 AI 偵測** \n先進的偵測確保只修改牙齒，維持真實且平衡的外觀。\n\n**可調整的美白強度** \n使用者可微調美白強度，以符合他們喜愛的風格。\n\n**以先進演算法達成的自然結果**\n\nAI 牙齒美白 API 使用精密的演算法，精準辨識牙齒並套用栩栩如生的美白效果。使用者可調整強度以達成細微、自然的改善，確保最終結果看起來真實且具視覺吸引力。\n\n---\n\n## 整合指南\n\n* 拍攝自拍\n\n * 在適當光線下正對鏡頭。\n * 使用 JS Camera Kit 拍攝照片。\n\n* 透過 ***/s2s/v2.0/file*** API 取得上傳網址與檔案 ID\n\n 使用檔案 API 回應中回傳的上傳網址，上傳下列檔案：\n * 您的自拍照片\n\n* 執行 AI 任務 ***/s2s/v2.0/task/teeth-whiten***\n\n 使用檔案 ID 或圖片網址作為輸入來源執行 AI 任務。依需求設定特效參數。\n\n* 輪詢任務狀態\n\n 使用回傳的 **task\\_id** 監控任務進度。 \n 輪詢 **GET /s2s/v2.0/task/teeth-whiten/{task_id}** 以查詢引擎狀態。 \n 任務會維持在**「執行中」**狀態，直到完成。任務執行期間不會消耗點數。\n\n\n\n* **使用示範**\n\n\n\n\n\n\n\n## 檔案規格與錯誤\n* 支援的格式與尺寸\n\n|類型|支援的尺寸|支援的檔案大小|支援的格式|\n| ---- | ---- | ---- | ---- |\n|AI 牙齒美白|自拍圖片：
* 長邊 ≤ 1920 px
* 短邊 ≥ 320 px |< 10MB|jpg/png|\n\n\n* 錯誤代碼\n\n|錯誤代碼|說明|\n| ---- | ---- |\n| error_exceed_max_image_size | 若圖片較長邊超過 1920 像素 |\n|error_below_min_image_size|若您的圖片寬或高小於 320 像素，尺寸過小無法使用|\n|error_face_position_invalid|您的臉部必須在圖片中完全可見，不可有任何部分被裁切|\n|error_face_position_too_small|您照片中的臉部太小，無法妥善分析|\n|error_face_position_out_of_boundary|您的臉部過大，或部分超出照片邊緣|\n|error_insufficient_lighting|光線過暗，導致難以分析|\n|error_face_angle_invalid|您的臉部角度不太正確。正面拍攝時，請讓頭部偏離直線不超過 10 度。側面拍攝時，角度應超過 15 度|\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## 點數消耗\n\n| AI 功能 | 消耗的點數 |\n|---|---|\n| AI 牙齒美白 V1.0 | 1 |\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/teeth-whiten/pre-process": {
"post": {
"summary": "執行 AI 牙齒美白的偵測任務。",
"description": "當來源照片可能包含超過一個有效目標，或您的整合需要明確選擇哪個被偵測到的目標接受特效時，請使用前處理任務。對於單一目標的圖片，當功能支援預設的 `index` 值，且您的應用程式不需要手動選擇目標時，可以跳過前處理。\n\n前處理任務會偵測來源照片中的候選目標，並在 `data.results.result` 中回傳它們的座標。結果陣列中的每個項目代表一個被偵測到的目標。檢視回傳的座標，將它們對應到來源照片中預期的臉部或區域，並在建立特效任務時，將該項目的零基陣列索引作為 `index` 值使用。\n\n對於偵測到多張臉或多個區域的圖片，請不要在未檢查前處理結果的情況下依賴預設的 `index` 值。特效只會套用到由 `index` 選定的目標，因此整合必須在執行特效任務前，確認對應到預期目標的結果項目。\n\n這個任務是非同步的。建立任務後，若功能支援，請以 webhook 處理完成，否則輪詢對應的前處理狀態端點，直到 `data.task_status` 為 `success` 或 `error`。\n",
"tags": [
"V1.0"
],
"security": [
{
"BearerAuthenticationV2": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRunTaskV2"
}
]
}
}
}
},
"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/teeth-whiten/pre-process/{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": {
"allOf": [
{
"$ref": "#/components/schemas/TaskStatusResponsePreProcessNoUrlBase"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"results": {
"type": "object",
"properties": {
"timed": {
"type": "number"
},
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"left": {
"type": "number"
},
"top": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
}
}
}
}
}
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidTaskId"
},
"401": {
"$ref": "#/components/responses/InvalidApiKey"
},
"500": {
"$ref": "#/components/responses/TaskTimeout"
}
}
}
},
"/s2s/v2.0/task/teeth-whiten": {
"post": {
"summary": "執行 AI 牙齒美白任務。",
"description": "AI 任務是非同步的。當功能支援 webhook 時，請優先使用以 webhook 為基礎的完成處理。設定您的 webhook 端點、驗證 webhook 簽章，並在收到 `success` 或 `error` 通知後，使用收到的 `task_id` 查詢任務結果。設定與驗證細節請見 [webhook 整合指南](/develop/webhook.md)。\n\n若您的整合不支援 webhook 或無法使用 webhook，請實作輪詢。送出 AI 任務後，以固定間隔（例如每 10 秒）輪詢狀態端點，直到任務狀態為 `success` 或 `error`。\n",
"tags": [
"V1.0"
],
"security": [
{
"BearerAuthenticationV2": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRunTaskV2"
},
{
"type": "object",
"required": [
"version",
"effect"
],
"properties": {
"version": {
"type": "string",
"enum": [
"1.0"
]
},
"index": {
"type": "integer",
"example": 0,
"default": 0,
"description": "要套用特效的目標物件的零基索引。對於含多個物件的圖片，請先執行前處理任務，檢查 `data.results.result` 中的物件座標，並將所選物件的索引傳入此處。\n\n前處理步驟會在套用任何特效之前，分析輸入圖片以識別所有可偵測的物件。它執行一個偵測任務，為每個物件回傳結構化資料，包含一個邊界框座標清單。清單中每個項目的位置，就是它的零基索引，隨後用於指定特效的目標物件。\n\n這些資訊以結構化格式回傳，通常位於 `data.results.result` 之下。\n先執行這個步驟，您可以：\n * 了解圖片中有多少物件\n * 檢查它們的位置與大小\n * 依索引選取正確的目標物件\n\n對於含多個物件的圖片，務必執行前處理步驟。\n檢視 `data.results.result` 以識別物件及其索引。\n使用對應的零基索引選取正確的目標。\n"
},
"effect": {
"type": "object",
"required": [
"whitening_intensity"
],
"properties": {
"whitening_intensity": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"skin_smooth_strength": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 50
},
"skin_smooth_color_intensity": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 50
}
}
}
}
}
]
}
}
}
},
"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/teeth-whiten/{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": {
"allOf": [
{
"$ref": "#/components/schemas/TaskStatusResponseV2"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"results": {
"type": "object",
"properties": {
"timed": {
"type": "number"
},
"timed_apply": {
"type": "number"
}
}
}
}
}
}
}
]
}
}
}
},
"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"
}
}
},
"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\\` - 其他"
},
"TaskStatusResponsePreProcessNoUrlBase": {
"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": "錯誤的詳細說明"
}
}
}
}
},
"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"
}
}
}
}
}
}
}
}
}