Documentație API pentru eliminarea fundalului

Trimite o imagine și primește un PNG transparent cu o singură cheie API.

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

Pornire rapidă

Solicită acces API →

Păstrează cheia emisă pe server, nu în browser sau aplicații publice. Rotirea păstrează identitatea și soldul clientului.

REMOX_API_KEY

Folosește JPG, PNG sau WebP static. Redimensionează înainte de încărcare; API nu redimensionează imagini.

Exemple de cod →

Autentificare

Păstrează cheia emisă pe server, nu în browser sau aplicații publice. Rotirea păstrează identitatea și soldul clientului.

CâmpValoare acceptată
X-API-Keyremox_live_… / remox_test_…
Secret / X-Subuid / X-Platform-User / X-RapidAPI-User—
image_url / Base64 / shadow / refine—

Exemple de cod

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.

Folosește JPG, PNG sau WebP static. Redimensionează înainte de încărcare; API nu redimensionează imagini.

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

Referință cerere

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

Folosește JPG, PNG sau WebP static. Redimensionează înainte de încărcare; API nu redimensionează imagini.

CâmpObligatoriuValoare acceptată
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 . _ : -

Răspunsuri

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

Expirare și reîncercări

După 60 de secunde, 504 poate indica o sarcină în curs. Verifică starea sau repetă cu aceeași imagine și Idempotency-Key pentru a evita taxe duble.

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

Cont și credite

Creditele sunt rezervate la creare, consumate la succes și eliberate la eșec sau expirarea sarcinii. Limita sincronă nu le eliberează.

CâmpValoare acceptată
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

Erori

Verifică errors și starea înainte de reîncercare. Păstrează requestId pentru asistență; nu înregistra cheia.

{
  "requestId": "req_…",
  "retryable": false,
  "errors": [
    {
      "code": "invalid_credentials",
      "title": "Invalid API key."
    }
  ]
}
HTTPerrors[].codeErori
400invalid_request, invalid_fileCerere invalidă
400invalid_size, invalid_response_formatCerere invalidă
400invalid_idempotency_key, invalid_subjectCerere invalidă
402insufficient_creditsCredite insuficiente
403invalid_credentialsAcces refuzat
403platform_disabled, platform_paused, scope_deniedAcces refuzat
404not_found, upload_not_foundNegăsit
409idempotency_conflictConflict sau sarcină neterminată
409result_not_readyConflict sau sarcină neterminată
410task_expired, result_expiredExpirat
413file_too_largeFișier prea mare
415invalid_image, animated_image_unsupportedImagine neacceptată
422image_dimensions_exceededDimensiuni depășite
429rate_limit_exceeded, hourly_quota_exhausted, inflight_limit_exceededLimită de cereri depășită
502upload_failed, upstream_rejected, upstream_unavailableEroare a serviciului extern
502create_result_unknown, remote_service_error, invalid_result, result_unavailable, task_failed, task_timeoutEroare a serviciului extern
503service_not_configured, credit_price_not_configured, server_errorServiciu indisponibil
504sync_timeoutExpirare sincronă

retryable: 429 / 5xx

După 60 de secunde, 504 poate indica o sarcină în curs. Verifică starea sau repetă cu aceeași imagine și Idempotency-Key pentru a evita taxe duble.

Compatibilitate

Doar eliminarea fundalului cu o cheie. Nu sunt implementate toate opțiunile remove.bg. URL-urile JSON sunt o extensie REMOX.

Solicită acces API →