換臉 API
透過簡單的 REST API,為你的產品加入照片與影片換臉功能。提交任務、輪詢結果,即可取得託管的輸出 URL。
所有訂閱方案都包含 API 存取權限。API 請求與網頁版共用相同的點數:沒有額外的 API 帳單。
運作方式
1
建立 API 金鑰
訂閱任一方案後,在儀表板的「API 金鑰」頁面建立金鑰。金鑰只會顯示一次,請妥善保存。
2
上傳媒體檔案
先申請一個預先簽章的上傳 URL,再將來源人臉與目標圖片或影片 PUT 到該 URL。
3
換臉並輪詢
提交換臉任務後持續輪詢任務狀態,直到 status 變成 succeeded,再下載 outputUrl。
身分驗證
每個請求都必須在 x-api-key 標頭中帶上你的 API 金鑰。金鑰屬於你的帳號,會消耗你帳號中的點數。請妥善保密金鑰;若不慎外洩,請到儀表板輪替金鑰。
x-api-key: adf_YOUR_API_KEY端點
POST /api/v1/uploads
為來源檔案或目標檔案建立預先簽章的上傳 URL。以相同的 Content-Type 將檔案 PUT 到 uploadUrl,然後在換臉請求中使用 url。支援的類型:JPEG、PNG、WebP、MP4、QuickTime、WebM。
curl -X POST https://aideepfake.io/api/v1/uploads \
-H "x-api-key: adf_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"fileName": "target.jpg", "contentType": "image/jpeg"}'
# → { "success": true, "data": { "uploadUrl": "...", "url": "https://...", "expiresIn": 600 } }
curl -X PUT "UPLOAD_URL_FROM_RESPONSE" \
-H "Content-Type: image/jpeg" \
--data-binary @target.jpgPOST /api/v1/face-swap
發起換臉任務。圖片換臉需 15 點數,影片換臉需 20 點數,與網頁版價格相同。將 targetType 設為 image 或 video。選填欄位:faceEnhance、frameEnhance、watermark,以及影片專用的 targetDurationSeconds。
curl -X POST https://aideepfake.io/api/v1/face-swap \
-H "x-api-key: adf_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sourceUrl": "https://.../source.jpg",
"targetUrl": "https://.../target.jpg",
"targetType": "image"
}'
# → { "success": true, "data": { "taskId": "...", "creditsCost": 15 } }影片長度限制:一般換臉最長 300 秒;開啟 faceEnhance 或 frameEnhance 時最長 90 秒。提高 face_swapper_pixel_boost 會依其倍率縮短這兩個上限,以 1024x1024 進行一般換臉時最長為 120 秒。
GET /api/v1/face-swap/{taskId}
輪詢任務狀態。status 欄位會從 processing 變為 succeeded 或 failed。成功時,outputUrl 會提供託管的結果檔案。失敗的任務會自動退還點數。
curl https://aideepfake.io/api/v1/face-swap/TASK_ID \
-H "x-api-key: adf_YOUR_API_KEY"
# → { "success": true, "data": { "taskId": "...", "status": "succeeded",
# "outputUrl": "https://...", "targetType": "image" } }GET /api/v1/credits
在提交任務前,查詢目前的點數餘額與方案。
curl https://aideepfake.io/api/v1/credits \
-H "x-api-key: adf_YOUR_API_KEY"
# → { "success": true, "data": { "credits": 1000,
# "subscriptionCredits": 985, "oneTimeCredits": 15,
# "checkInCredits": 0, "planId": "...",
# "currentPeriodEnd": "..." } }價格與配額
API 沒有另外的價目表。每個請求都會消耗訂閱方案中的點數:每次圖片換臉 15 點數,每次影片換臉 20 點數,與網頁版完全相同。每月點數配額由你的方案決定。
比較方案錯誤代碼
| HTTP | 代碼 | 說明 |
|---|---|---|
| 401 | INVALID_API_KEY | API 金鑰缺少、無效、已停用或已過期。 |
| 403 | API_REQUIRES_SUBSCRIPTION | 帳號沒有有效的訂閱。請先訂閱方案再使用 API。 |
| 402 | INSUFFICIENT_CREDITS | 帳號點數不足以完成此任務。請升級方案或購買點數包。 |
| 400 | VIDEO_TOO_LONG | 影片長度超過所選選項的限制。 |
| 429 | RATE_LIMITED | 請求次數過多。請放慢速度,稍候再試。 |
常見問題
誰可以使用換臉 API?
所有擁有有效訂閱方案的使用者。瀏覽器中自動發放的免費點數僅適用於網頁版,不適用於 API。
API 請求如何計費?
與網頁版相同:每次圖片換臉 15 點數,每次影片換臉 20 點數。API 請求與你在網頁版的使用共用同一個點數餘額。
API 支援影片換臉嗎?
支援。將 targetType 設為 video。一般影片換臉最長 300 秒;啟用臉部或畫面增強的換臉最長 90 秒。
如何取得結果?
輪詢 GET /api/v1/face-swap/{taskId},直到 status 變成 succeeded。回應中的 outputUrl 會指向託管的結果檔案。
任務失敗會怎麼樣?
失敗的任務會自動退還點數。狀態回應中的 error 欄位會說明失敗原因。
訂閱結束後會怎麼樣?
你的 API 金鑰會立即失效。重新訂閱後,金鑰就會恢復可用:不需要建立新的金鑰。
開始開發
建立你的 API 金鑰,幾分鐘內完成第一次換臉呼叫。
建立 API 金鑰