これは便宜上提供される翻訳です。技術的に正式なリファレンスは英語版であり、相違がある場合は英語の本文が優先されます。

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つのクレジット残高を共有します。

クレジットと料金

各ファイルの料金は処理された長さ1秒あたり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セグメンテーションの代わりにフラッドフィルを使用します — 高速で、単色背景で最も効果的です
tolerance832 (デフォルト 16)method=fast でのみ使用されます
croptrue (デフォルト) · false被写体のバウンディングボックスに自動でトリミングします
pad050 px (デフォルト 12)トリミングの周囲に残す余白
canvasW / canvasHpx出力キャンバスサイズ。省略すると元のサイズを維持します
anchorcenter (デフォルト) · bottomキャンバスに合わせて拡大縮小する際の被写体の配置
outputFormatgif (デフォルト) · apng · webm · mp4mp4 に関する下記の注記を参照
bgColortransparent (デフォルト) · #rrggbbmp4 には必須
trimtrue · false (デフォルト)先頭/末尾のアイドルフレームを自動でトリミングします — GIFソースのみ

mp4 出力にはアルファチャンネルがないため、単色の 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 はプレビューが利用可能になると表示されます。downloadUrlstatusdone になったときのみ表示されます。ジョブはそれを作成したAPIキーにのみ表示されます — 他のすべてのキーは 404 を受け取ります。

プレビューとダウンロード

GET /api/v1/jobs/:id/previewGET /api/v1/jobs/:id/download は、他のすべての呼び出しと同じ方法で認証され、ファイルを直接ストリーミングします — 別途のダウンロードトークンは不要です。

バッチ — POST /api/v1/batches

POST /api/v1/jobs と同じフィールドですが、file フィールドをファイルごとに1回繰り返します(1リクエストあたり最大 20ファイル)。1つのオプションセットがバッチ内のすべてのファイルに適用されます。

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キーを取得