本頁面為方便閱讀而提供的譯文。技術權威版本為英文版;如有任何不一致,以英文文本為準。
身分驗證
每個請求都需要一個 API 金鑰,透過以下任一標頭發送:
在你的儀表板的「API 金鑰」面板中建立金鑰。明文金鑰僅在建立時顯示一次 —— 如果遺失,請撤銷它並產生新的。你最多可同時擁有 10 個有效金鑰;它們共享同一個點數餘額。
點數與定價
每個檔案的費用為處理時長每秒 1 點數,最低 3 點數 —— 2 秒的片段仍按 3 點數的下限計費,10 秒的片段計 10 點數。點數在任務提交時(處理開始前)扣除,基於檔案本身的時長,而非固定的每檔案費率。批次請求會預先為批次中的每個檔案計費 —— 如果你的餘額無法涵蓋整個批次,則其中不會建立任何內容。如果某個檔案結果無法讀取,該檔案的點數會自動退還。
| 方案 | 點數 | 價格 |
|---|---|---|
| 點數包 — 微型 | 15(永不過期) | $1.99 |
| 點數包 — 輕量 | 150(永不過期) | $9.99 |
| 點數包 — 重度 | 900(永不過期) | $39.99 |
| Plus 季付 | 2,700 / 季 | $79.99/季 |
| Pro 月付 | 3,000 / 月 | $79.99/月 |
| Pro 年付 | 36,000 / 年 | $799.99/年 |
點數存在於你的帳戶上,而非單個金鑰上 —— 你建立的每個金鑰都從同一個池中扣取。隨時可透過 GET /api/account 查看餘額(儀表板工作階段認證,非 API 金鑰認證)。
提交檔案 — POST /api/v1/jobs
Multipart 表單資料:
| 欄位 | 取值 | 說明 |
|---|---|---|
file | 必填 | .gif, .mp4, .mov, .webm |
method | auto (預設) · fast · rembg | fast 使用泛洪填充而非 AI 分割 —— 更快,在純色背景上效果最佳 |
tolerance | 8–32 (預設 16) | 僅由 method=fast 使用 |
crop | true (預設) · false | 自動裁切到主體的邊界框 |
pad | 0–50 px (預設 12) | 裁切周圍保留的內邊距 |
canvasW / canvasH | px | 輸出畫布尺寸;省略則保持原始尺寸 |
anchor | center (預設) · bottom | 縮放到畫布時的主體位置 |
outputFormat | gif (預設) · apng · webm · mp4 | 參見下方關於 mp4 的說明 |
bgColor | transparent (預設) · #rrggbb | mp4 必需 |
trim | true · false (預設) | 自動修剪開頭/結尾的靜止影格 —— 僅限 GIF 來源 |
mp4 輸出沒有 alpha 通道,因此只有搭配純色 bgColor 才有意義 —— 用透明背景請求 mp4 會自動回退為 gif。
回應 202:
輪詢狀態 — GET /api/v1/jobs/:id
previewUrl 在預覽可用後出現;downloadUrl 僅在 status 為 done 時出現。任務僅對建立它的 API 金鑰可見 —— 其他任何金鑰都會得到 404。
預覽與下載
GET /api/v1/jobs/:id/preview 和 GET /api/v1/jobs/:id/download 直接串流檔案,認證方式與其他所有呼叫相同 —— 無需單獨的下載權杖。
批次處理 — POST /api/v1/batches
欄位與 POST /api/v1/jobs 相同,但每個檔案重複一次 file 欄位(每個請求最多 20 個檔案)。一組選項套用於批次中的每個檔案。
GET /api/v1/batches/:id 回傳 { "id", "status": "processing | partial | done", "jobs": [...] },每個項目的結構與 GET /api/v1/jobs/:id 相同。
錯誤
| 狀態碼 | 回應主體 | 含義 |
|---|---|---|
401 | { "error": "unauthorized" } | 缺失、無效或已撤銷的 API 金鑰 |
402 | { "error": "insufficient_credits", "creditsRemaining" } | 點數不足 —— 未建立任務 |
400 | { "error": "bad_request" } | 沒有有效檔案,或 multipart 請求主體格式錯誤 |
422 | { "error": "unreadable_file" } | 檔案無法解析 —— 未扣點數 |
404 | { "error": "not_found" } | 任務/批次不存在,或屬於其他金鑰 |
429 | { "error": "rate_limited" } | 請求過多 —— 參見 Retry-After 標頭 |
速率限制
請求按 API 金鑰進行速率限制。如果你被限流,回應會包含一個 Retry-After 標頭(秒)—— 等待相應時長後再重試。生產整合需要更高的限額?從你的儀表板聯絡我們。