本页面为方便阅读而提供的译文。技术权威版本为英文版；如有任何不一致，以英文文本为准。

curl -X POST https://removegifbg.com/api/v1/jobs \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "file=@input.gif"

身份验证

每个请求都需要一个 API 密钥，通过以下任一标头发送：

Authorization: Bearer bgr_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
X-API-Key: bgr_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

在你的仪表板的“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
methodauto (默认) · fast · rembgfast 使用泛洪填充而非 AI 分割 —— 更快，在纯色背景上效果最佳
tolerance8–32 (默认 16)仅由 method=fast 使用
croptrue (默认) · false自动裁剪到主体的边界框
pad0–50 px (默认 12)裁剪周围保留的内边距
canvasW / canvasHpx输出画布尺寸；省略则保持原始尺寸
anchorcenter (默认) · bottom缩放到画布时的主体位置
outputFormatgif (默认) · apng · webm · mp4参见下方关于 mp4 的说明
bgColortransparent (默认) · #rrggbbmp4 必需
trimtrue · false (默认)自动修剪开头/结尾的静止帧 —— 仅限 GIF 源

mp4 输出没有 alpha 通道，因此只有搭配纯色 bgColor 才有意义 —— 用透明背景请求 mp4 会自动回退为 gif。

curl -X POST https://removegifbg.com/api/v1/jobs \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "file=@input.gif" \ -F "outputFormat=apng" \ -F "bgColor=transparent"

响应 202：

{ "id": "b165...", "status": "queued", "creditsRemaining": 19, "links": { "self": "/api/v1/jobs/b165...", "download": "/api/v1/jobs/b165.../download" } }

轮询状态 — GET /api/v1/jobs/:id

curl https://removegifbg.com/api/v1/jobs/b165... \ -H "Authorization: Bearer YOUR_API_KEY"
{ "id": "b165...", "status": "queued | processing | done | failed", "metadata": { "originalName": "input.gif", "inputSize": 372273, "frameCount": 14, "width": 512, "height": 512, "duration": 0.84, "outputSize": 158210 }, "outputFormat": "gif", "previewUrl": "/api/v1/jobs/b165.../preview", "downloadUrl": "/api/v1/jobs/b165.../download", "error": null }

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 个文件）。一组选项应用于批次中的每个文件。

curl -X POST https://removegifbg.com/api/v1/batches \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "file=@a.gif" -F "file=@b.gif" -F "file=@c.gif"
{ "id": "batch_...", "jobs": [{ "id": "...", "filename": "a.gif" }], "creditsRemaining": 15 }

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 标头（秒）—— 等待相应时长后再重试。生产集成需要更高的限额？从你的仪表板联系我们。

获取 API 密钥