Codia

Remove BG

概覽

Remove BG 去除任意影像的背景,回傳透明 PNG。一個端點、一個必填欄位、一種回應結構。面向商品頁、設計工具、廣告創意流水線,以及任何需要規模化去背的場景。

端點

POSThttps://api.codia.ai/v1/open/remove_bg

透過 Bearer Token 驗證。在 codia.ai/dashboard/developer 取得 Key。

請求

欄位型別必填說明
image_urlstring可公開存取的來源影像 URL。

範例

bash
curl 'https://api.codia.ai/v1/open/remove_bg' \ -H 'Authorization: Bearer {codia_api_key}' \ -H 'Content-Type: application/json' \ --data '{ "image_url": "your image url" }'

回應

json
{ "code": 0, "message": "ok", "data": { "image_url": "https://processed-image-url.com/result.png" } }
欄位說明
code0 為成功,非 0 表示輸入或處理錯誤。
message人類可讀狀態。
data.image_url結果 PNG 的 CDN URL,透明背景。儘快下載並存到你方儲存,URL 非長效。

輸出特性

  • 格式 —— 帶 alpha 通道的 PNG。
  • 解析度 —— 與輸入一致,受方案上限約束(全方案均支援 HD)。
  • 邊緣品質 —— 亞像素 matte、前景顏色去汙染,無背景投影拖尾。
  • 主體自陰影 —— 保留(如馬克杯暗側)。

效能

項目數值
典型處理時間約 600 ms
端到端延遲800 – 1200 ms
並行方案相關;常見方案支援數百並行。

支援的輸入

輸入建議
常見格式JPEG、PNG、WEBP
最低解析度長邊 400 px
大小上限方案相關,預設 25 MB
已含 alpha 的圖先在白底扁平化以保留預期透明度
極端運動模糊可用,但邊緣更柔和
主體/背景同色(白對白)可用,建議加人工審查

錯誤碼

code含義
0成功。
40001image_url 缺失或不可達。
40002格式不支援。
40003超過大小限制。
42900速率限制——退避後重試。
50000伺服端暫時錯誤——指數退避重試。

非 0 code 應分流處理:暫時錯誤重試,輸入錯誤快速失敗。

整合模式

商品上傳(同步)

js
const res = await fetch('https://api.codia.ai/v1/open/remove_bg', { method: 'POST', headers: { 'Authorization': `Bearer ${CODIA_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ image_url: sourceUrl }), }).then((r) => r.json()) if (res.code === 0) { await saveToBucket(res.data.image_url) }

批次匯入(非同步)

大目錄場景下按方案並行上限起 worker 池,暫時失敗重試。低於最小解析度的圖跳過,不浪費呼叫。

合成

開發階段把回傳 PNG 合成到深色背景(如 #111),檢查邊緣 fringe。乾淨去背能經受;出現光暈需檢查輸入。

常見問題

能用上傳代替 URL 嗎?

當前端點需要 URL。若需要 multipart 上傳,請聯繫 [email protected]——路線圖內,企業方案已可用。

輸出 URL 永久有效嗎?

不是。請下載並存到自家儲存,URL 下載後會過期。

按圖片大小分檔計費嗎?

不。按成功呼叫計費,統一價。

未用額度會歸零嗎?

付費方案按月滾動。詳見定價

可以保留投影嗎?

預設去除全部背景(含投影)。企業部署可透過設定保留投影。

下一步