{
"openapi": "3.0.0",
"info": {
"title": "AI 影片物件移除",
"description": "# 概述\n\n**AI 影片物件移除**\n\n\n\nAI 影片物件移除 API 能無縫移除影片內容中不想要的元素。無論是擠滿遊客的擁擠背景、雜亂的環境（如放著衛生紙與瓶子的桌面），或玻璃表面上令人分心的倒影，API 都能以高準確度與一致性，精準可靠地消除遮罩區域。\n\n\n---\n\n## 整合指南\n\n**1. 準備來源影片與遮罩圖片**\n輸入影片長度不得超過 60 秒，輸出影片的長軸須為 1920 像素或以下，影格率為每秒 30 影格或以下。\n\n\n**2. 上傳檔案**\n透過以下方式請求上傳網址與檔案 ID：\n\n```\nPOST /s2s/v2.0/file\n```\n\n輸入影片：\n\n\n\n\n參考輸入遮罩：\n\n\n\n\n**3. 執行 AI 任務**\n\n```\nPOST /s2s/v2.0/task/obj-rem-vid\n```\n\n使用檔案 ID 或圖片網址作為輸入提交任務。回應會回傳 task_id 用於追蹤與取得結果。\n\n\n**4. 取得任務結果**\n\n```\nGET /s2s/v2.0/task/obj-rem-vid/{task_id}\n```\n\n使用任務 ID 追蹤狀態並取得結果。\n\n可設定 [Webhooks](/develop/webhook.md) 在任務完成時接收非同步通知，狀態為 success 或 error。也支援輪詢，重複呼叫任務端點直到狀態從 running 更新為 success 或 error。\n\n僅在任務成功完成時才計費。\n\n\n輸出影片範例：\n\n\n\n\n---\n\n## 檔案規格與錯誤\n\n* 支援的格式與尺寸\n\n|AI 功能|支援的尺寸|支援的檔案大小|支援的格式|\n| ---- | ---- | ---- | ---- |\n| AI 影片物件移除 | 輸入影片長度不得超過 60 秒，輸出影片的長軸須為 1920 像素或以下，影格率為每秒 30 影格或以下。 | 長度限制：60 秒 | 容器：mov, mp4
影像：MPEG-4, MPEG-4 AVC,
音訊：aac, amr, mp3 |\n\n* 錯誤代碼\n\n|錯誤代碼|說明|\n| ---- | ---- |\n| error_download_video | 下載來源影片錯誤 |\n| error_decode_video | 解碼來源影片錯誤 |\n| error_unsupported_video | 不支援的影片格式 |\n| exceed_max_filesize | 輸入檔案大小超過上限|\n| error_nsfw_content_detected | 在來源檔案中偵測到 NSFW 內容 |\n| error_decode_mask | 解碼遮罩圖片錯誤 |\n| invalid_parameter | 參數值無效|\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 影片物件移除 V2.1 | 2（1 秒）* |\n\n > *若圖片數量或影片長度無法整除，點數無條件進位。\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.1",
"description": "AI 影片物件移除"
}
],
"paths": {
"/s2s/v2.0/file/obj-rem-vid": {
"post": {
"summary": "建立新檔案。",
"description": "要上傳新檔案，您必須先使用 File API。它會提供一個網址——請使用該網址上傳您的檔案。上傳完成後，您可以使用同一個回應中的 file_id，開始使用我們的 AI 功能。",
"tags": [
"V2.1"
],
"security": [
{
"BearerAuthenticationV2": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/VideoFileV1.1"
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功取得檔案上傳資訊",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/VideoFileResponseV2"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidParameters"
},
"401": {
"$ref": "#/components/responses/InvalidApiKey"
}
}
}
},
"/s2s/v2.0/task/obj-rem-vid": {
"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": [
"V2.1"
],
"security": [
{
"BearerAuthenticationV2": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRunVidTaskV2WithRequiredMsk"
},
{
"type": "object",
"required": [
"frame_idx"
],
"properties": {
"frame_idx": {
"type": "integer",
"description": "指定輸入影片中對應所提供遮罩圖片的影格索引，範圍為 0 到總影格數減 1。",
"example": 0
}
}
}
]
}
}
}
},
"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/obj-rem-vid/{task_id}": {
"get": {
"summary": "查詢 AI 影片物件移除任務的狀態。",
"tags": [
"V2.1"
],
"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/VidTaskStatusResponseV2"
}
}
}
},
"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": {
"VideoFileV1.1": {
"title": "VideoFile V1.1",
"description": "這個物件代表一個影片檔案。",
"type": "object",
"required": [
"files"
],
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"content_type",
"file_name",
"file_size"
],
"properties": {
"content_type": {
"type": "string",
"example": "video/mp4",
"description": "這個檔案的內容 MIME 類型。目前可用的值列於 enum 中。"
},
"file_name": {
"type": "string",
"example": "my-selfie.mp4",
"description": "這個檔案的名稱"
},
"file_size": {
"type": "integer",
"example": 50000,
"description": "此檔案的內容長度（位元組）。不應超過 100MB。"
}
}
}
}
}
},
"BasicVideoFileResponse": {
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content_type": {
"type": "string",
"example": "video/mp4",
"description": "這個檔案的內容 MIME 類型。"
},
"file_name": {
"type": "string",
"example": "my-selfie.mp4",
"description": "這個檔案的名稱"
},
"file_id": {
"type": "string",
"example": "U8aqJbsXGT537jtGnEDFHqxdDXqh8+oTF/cSkLimzuvVwMP+Jb1XbjPsf7ZgUgLY",
"description": "此檔案的 ID。其他執行任務 API 會需要這個 \\`file_id\\`。"
},
"requests": {
"type": "array",
"description": "使用下方的 \\`url\\`、\\`headers\\`、\\`method\\` 上傳檔案。完成後，\\`file_id\\` 將用於後續呼叫執行任務 API。",
"items": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"example": {
"Content-Type": "video/mp4",
"Content-Length": 50000
},
"description": "上傳檔案時要納入的標頭"
},
"url": {
"type": "string",
"example": "https://example.com/presigned-upload-url",
"description": "上傳這個檔案的網址"
},
"method": {
"type": "string",
"example": "PUT",
"description": "上傳這個檔案所用的 HTTP 方法"
}
}
}
}
}
}
}
}
},
"VideoFileResponseV2": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 200,
"description": "回應狀態"
},
"data": null
},
"$ref": "#/components/schemas/BasicVideoFileResponse"
},
"BasicRunTaskV2VidSrcFileUrl": {
"type": "object",
"required": [
"src_file_url"
],
"properties": {
"src_file_url": {
"type": "string",
"description": "要執行任務的檔案網址。該網址應可公開存取。",
"example": "https://example.com/cat_video.mp4"
}
}
},
"BasicRunTaskV2MskFileUrl": {
"type": "object",
"properties": {
"msk_file_url": {
"type": "string",
"example": "https://example.com/mask.jpg",
"description": "遮罩檔案的網址。這必須是一張與輸入圖片寬高完全相同的灰階遮罩圖片，白色像素代表前景，黑色像素代表背景。該網址需可公開存取。"
}
}
},
"BasicRunTaskV2MskFileId": {
"type": "object",
"properties": {
"msk_file_id": {
"type": "string",
"example": "eA1CCL3kG4w2s0kpbo2pkah59VfxzIjxahJD2wWm7zw=",
"description": "遮罩檔案的 ID。這必須是一張與輸入圖片寬高完全相同的灰階遮罩圖片，白色像素代表前景，黑色像素代表背景。來自上傳檔案 API 的檔案 ID。"
}
}
},
"BasicRunTaskV2SrcFileId": {
"type": "object",
"required": [
"src_file_id"
],
"properties": {
"src_file_id": {
"type": "string",
"description": "要執行任務的檔案 ID。檔案 ID 來自上傳檔案 API。",
"example": "pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
}
}
},
"BasicRunVidTaskV2WithRequiredMsk": {
"title": "BasicRunVidTaskV2WithRequiredMsk",
"anyOf": [
{
"allOf": [
{
"title": "Run task with src video url & msk file url",
"required": [
"msk_file_url"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2VidSrcFileUrl"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2MskFileUrl"
}
]
},
{
"allOf": [
{
"title": "Run task with src video url & msk file ID",
"required": [
"msk_file_id"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2VidSrcFileUrl"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2MskFileId"
}
]
},
{
"allOf": [
{
"title": "Run task with src file ID & msk file url",
"required": [
"msk_file_url"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileId"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2MskFileUrl"
}
]
},
{
"allOf": [
{
"title": "Run task with src file ID & msk file ID",
"required": [
"msk_file_id"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileId"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2MskFileId"
}
]
}
]
},
"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\\` - 其他"
},
"VidTaskStatusResponseBodySingleUrlResultsV2": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "下載這個結果的網址。有效期限 2 小時",
"example": "https://example.com/sample-result-url"
}
}
},
"VidTaskStatusResponseV2": {
"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/VidTaskStatusResponseBodySingleUrlResultsV2"
}
},
"responses": {
"InvalidParameters": {
"description": "請求參數無效",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 400,
"description": "回應狀態"
},
"error": {
"type": "string",
"example": "Invalid parameter value"
},
"error_code": {
"type": "string",
"example": "InvalidParameters"
}
}
}
}
}
},
"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"
}
}
}
}
}
}
}
}
}