API-Dokumentation zur Hintergrundentfernung

Sende ein Bild und erhalte mit einem API-Schlüssel ein transparentes PNG.

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

Schnellstart

Bewahre den ausgestellten Schlüssel auf deinem Server auf, niemals im Browser oder in öffentlichen Apps. Ein Wechsel erhält Kundenidentität und Guthaben.

REMOX_API_KEY

JPG, PNG oder statisches WebP verwenden. Vor dem Upload skalieren; die API verkleinert keine Bilder.

Codebeispiele →

Authentifizierung

Bewahre den ausgestellten Schlüssel auf deinem Server auf, niemals im Browser oder in öffentlichen Apps. Ein Wechsel erhält Kundenidentität und Guthaben.

Feld	Zulässiger Wert
X-API-Key	remox_live_… / remox_test_…
Secret / X-Subuid / X-Platform-User / X-RapidAPI-User	—
image_url / Base64 / shadow / refine	—

Codebeispiele

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 oder statisches WebP verwenden. Vor dem Upload skalieren; die API verkleinert keine Bilder.

input.jpg → image/jpeg · PNG → image/png · WebP → image/webp

Anfragereferenz

POST /v1.0/removebg · multipart/form-data

JPG, PNG oder statisches WebP verwenden. Vor dem Upload skalieren; die API verkleinert keine Bilder.

Feld	Erforderlich	Zulässiger Wert
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 . _ : -

Antworten

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

Zeitüberschreitungen und Wiederholungen

Nach 60 Sekunden kann 504 eine laufende Aufgabe bedeuten. Status abfragen oder mit gleichem Bild und Idempotency-Key wiederholen, um doppelte Kosten zu vermeiden.

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

Konto und Credits

Credits werden bei Erstellung reserviert, bei Erfolg verbraucht und bei Fehler oder Ablauf freigegeben. Ein synchrones Zeitlimit gibt sie nicht frei.

Feld	Zulässiger Wert
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

Fehler

Vor Wiederholung errors und Aufgabenstatus prüfen. requestId für den Support speichern; den Schlüssel niemals protokollieren.

{
  "requestId": "req_…",
  "retryable": false,
  "errors": [
    {
      "code": "invalid_credentials",
      "title": "Invalid API key."
    }
  ]
}

HTTP	errors[].code	Fehler
400	invalid_request, invalid_file	Ungültige Anfrage
400	invalid_size, invalid_response_format	Ungültige Anfrage
400	invalid_idempotency_key, invalid_subject	Ungültige Anfrage
402	insufficient_credits	Unzureichende Credits
403	invalid_credentials	Zugriff verweigert
403	platform_disabled, platform_paused, scope_denied	Zugriff verweigert
404	not_found, upload_not_found	Nicht gefunden
409	idempotency_conflict	Konflikt oder unerledigte Aufgabe
409	result_not_ready	Konflikt oder unerledigte Aufgabe
410	task_expired, result_expired	Abgelaufen
413	file_too_large	Datei zu groß
415	invalid_image, animated_image_unsupported	Nicht unterstütztes Bild
422	image_dimensions_exceeded	Bildmaße überschritten
429	rate_limit_exceeded, hourly_quota_exhausted, inflight_limit_exceeded	Anfragelimit erreicht
502	upload_failed, upstream_rejected, upstream_unavailable	Fehler beim vorgelagerten Dienst
502	create_result_unknown, remote_service_error, invalid_result, result_unavailable, task_failed, task_timeout	Fehler beim vorgelagerten Dienst
503	service_not_configured, credit_price_not_configured, server_error	Dienst nicht verfügbar
504	sync_timeout	Synchrones Zeitlimit überschritten

retryable: 429 / 5xx

Nach 60 Sekunden kann 504 eine laufende Aufgabe bedeuten. Status abfragen oder mit gleichem Bild und Idempotency-Key wiederholen, um doppelte Kosten zu vermeiden.

Kompatibilität

Nur Hintergrundentfernung mit reinem Schlüssel. Nicht alle remove.bg-Funktionen sind implementiert. JSON-Ergebnis-URLs sind eine REMOX-Erweiterung.

API-Zugang beantragen →