背景除去 API ドキュメント

1つの API キーで画像を送信し、透過 PNG を取得します。

POSThttps://api.remox.ai/v1.0/removebg

クイックスタート

API 利用を申請 →

発行済みキーはサーバーに保存し、ブラウザーやアプリに公開しないでください。キーを更新しても顧客 ID と残高は維持されます。

REMOX_API_KEY

JPG、PNG、静止 WebP に対応。アップロード前にサイズを調整してください。API は画像を縮小しません。

コード例 →

認証

発行済みキーはサーバーに保存し、ブラウザーやアプリに公開しないでください。キーを更新しても顧客 ID と残高は維持されます。

項目許容値
X-API-Keyremox_live_… / remox_test_…
Secret / X-Subuid / X-Platform-User / X-RapidAPI-User—
image_url / Base64 / shadow / refine—

コード例

cURL
# 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-data

JPG、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/png

X-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=json

creating → queued → processing → completed / failed / timed_out

Retry-After · pollAfterMs: 2000 · X-API-Key

アカウントとクレジット

作成時にクレジットを予約し、成功時に消費、失敗またはタスク期限切れ時に解放します。同期タイムアウトだけでは解放されません。

項目許容値
creditsavailable / reserved / consumed
GET /v1.0/accountX-API-Key
POST → AI300 ms
POST → 50460 s
task → timed_out35 min
task_expired90 d
result_expired (Worker)7 d

エラー

再試行前に errors 配列とタスク状態を確認。サポート用に requestId を保存し、API キーは記録しないでください。

{
  "requestId": "req_…",
  "retryable": false,
  "errors": [
    {
      "code": "invalid_credentials",
      "title": "Invalid API key."
    }
  ]
}
HTTPerrors[].codeエラー
400invalid_request, invalid_fileリクエストが無効
400invalid_size, invalid_response_formatリクエストが無効
400invalid_idempotency_key, invalid_subjectリクエストが無効
402insufficient_creditsクレジット不足
403invalid_credentialsアクセス拒否
403platform_disabled, platform_paused, scope_deniedアクセス拒否
404not_found, upload_not_found見つかりません
409idempotency_conflict競合または未完了のタスク
409result_not_ready競合または未完了のタスク
410task_expired, result_expired期限切れ
413file_too_largeファイルが大きすぎます
415invalid_image, animated_image_unsupported未対応の画像
422image_dimensions_exceeded画像サイズ超過
429rate_limit_exceeded, hourly_quota_exhausted, inflight_limit_exceededリクエスト上限超過
502upload_failed, upstream_rejected, upstream_unavailable上流サービスの障害
502create_result_unknown, remote_service_error, invalid_result, result_unavailable, task_failed, task_timeout上流サービスの障害
503service_not_configured, credit_price_not_configured, server_errorサービス利用不可
504sync_timeout同期タイムアウト

retryable: 429 / 5xx

60秒後の504でもタスクは実行中の場合があります。状態を確認するか、同じ画像と Idempotency-Key で再試行し、重複課金を防ぎます。

互換性

この API はキーのみの背景除去専用です。remove.bg の全機能には対応しません。JSON 結果 URL は REMOX 独自の拡張です。

API 利用を申請 →