背景除去 API ドキュメント
1つの API キーで画像を送信し、透過 PNG を取得します。
https://api.remox.ai/v1.0/removebgクイックスタート
API 利用を申請 →発行済みキーはサーバーに保存し、ブラウザーやアプリに公開しないでください。キーを更新しても顧客 ID と残高は維持されます。
REMOX_API_KEYJPG、PNG、静止 WebP に対応。アップロード前にサイズを調整してください。API は画像を縮小しません。
コード例 →認証
発行済みキーはサーバーに保存し、ブラウザーやアプリに公開しないでください。キーを更新しても顧客 ID と残高は維持されます。
| 項目 | 許容値 |
|---|---|
| X-API-Key | remox_live_… / remox_test_… |
| Secret / X-Subuid / X-Platform-User / X-RapidAPI-User | — |
| image_url / Base64 / shadow / refine | — |
コード例
# Set REMOX_API_KEY in your environment first.
curl 'https://api.remox.ai/v1.0/removebg' \
-H "X-API-Key: $REMOX_API_KEY" \
-H 'Idempotency-Key: image-0001' \
-F 'image_file=@/path/to/input.jpg' \
-F 'size=auto' \
--max-time 75 --fail-with-body \
-D response-headers.txt -o remox-result.png
# On non-2xx, the output file contains error JSON, not a PNG.JPG、PNG、静止 WebP に対応。アップロード前にサイズを調整してください。API は画像を縮小しません。
input.jpg → image/jpeg · PNG → image/png · WebP → image/webpリクエスト仕様
POST /v1.0/removebg · multipart/form-dataJPG、PNG、静止 WebP に対応。アップロード前にサイズを調整してください。API は画像を縮小しません。
| 項目 | 必須 | 許容値 |
|---|---|---|
| image_file | ✓ | JPG / PNG / WebP · ≤20 MiB (20 × 1024 × 1024 bytes) · max(width, height) ≤1920 px · min(width, height) ≤1080 px |
| size | — | auto |
| response_format | — | image / json |
| Idempotency-Key | — | 8–128 · A–Z a–z 0–9 . _ : - |
レスポンス
200 · PNG
response_format=image · Content-Type: image/pngX-Request-ID · X-Task-ID · X-Idempotency-Key
200 · JSON
response_format=json{
"requestId": "req_…",
"taskId": "task_…",
"data": {
"result_url": "https://storage.example/result.png?signature=…&expires=…"
}
}data.result_url ≠ result_b64タイムアウトと再試行
60秒後の504でもタスクは実行中の場合があります。状態を確認するか、同じ画像と Idempotency-Key で再試行し、重複課金を防ぎます。
GET /v1.0/tasks/{taskId}{
"requestId": "req_…",
"taskId": "task_…",
"status": "completed",
"progress": null,
"pollAfterMs": 2000,
"result": {
"downloadPath": "/v1.0/tasks/task_…/result",
"mimeType": "image/png",
"expiresAt": "2026-10-17T00:00:00.000Z"
}
}GET /v1.0/tasks/{taskId}/result
GET /v1.0/tasks/{taskId}/result?response_format=jsoncreating → queued → processing → completed / failed / timed_out
Retry-After · pollAfterMs: 2000 · X-API-Key
アカウントとクレジット
作成時にクレジットを予約し、成功時に消費、失敗またはタスク期限切れ時に解放します。同期タイムアウトだけでは解放されません。
| 項目 | 許容値 |
|---|---|
| credits | available / reserved / consumed |
| GET /v1.0/account | X-API-Key |
| POST → AI | 300 ms |
| POST → 504 | 60 s |
| task → timed_out | 35 min |
| task_expired | 90 d |
| result_expired (Worker) | 7 d |
エラー
再試行前に errors 配列とタスク状態を確認。サポート用に requestId を保存し、API キーは記録しないでください。
{
"requestId": "req_…",
"retryable": false,
"errors": [
{
"code": "invalid_credentials",
"title": "Invalid API key."
}
]
}| HTTP | errors[].code | エラー |
|---|---|---|
| 400 | invalid_request, invalid_file | リクエストが無効 |
| 400 | invalid_size, invalid_response_format | リクエストが無効 |
| 400 | invalid_idempotency_key, invalid_subject | リクエストが無効 |
| 402 | insufficient_credits | クレジット不足 |
| 403 | invalid_credentials | アクセス拒否 |
| 403 | platform_disabled, platform_paused, scope_denied | アクセス拒否 |
| 404 | not_found, upload_not_found | 見つかりません |
| 409 | idempotency_conflict | 競合または未完了のタスク |
| 409 | result_not_ready | 競合または未完了のタスク |
| 410 | task_expired, result_expired | 期限切れ |
| 413 | file_too_large | ファイルが大きすぎます |
| 415 | invalid_image, animated_image_unsupported | 未対応の画像 |
| 422 | image_dimensions_exceeded | 画像サイズ超過 |
| 429 | rate_limit_exceeded, hourly_quota_exhausted, inflight_limit_exceeded | リクエスト上限超過 |
| 502 | upload_failed, upstream_rejected, upstream_unavailable | 上流サービスの障害 |
| 502 | create_result_unknown, remote_service_error, invalid_result, result_unavailable, task_failed, task_timeout | 上流サービスの障害 |
| 503 | service_not_configured, credit_price_not_configured, server_error | サービス利用不可 |
| 504 | sync_timeout | 同期タイムアウト |
retryable: 429 / 5xx
60秒後の504でもタスクは実行中の場合があります。状態を確認するか、同じ画像と Idempotency-Key で再試行し、重複課金を防ぎます。
互換性
この API はキーのみの背景除去専用です。remove.bg の全機能には対応しません。JSON 結果 URL は REMOX 独自の拡張です。
API 利用を申請 →