Taustanpoiston API-dokumentaatio

Lähetä kuva ja vastaanota läpinäkyvä PNG yhdellä API-avaimella.

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

Pika-aloitus

Säilytä myönnetty avain palvelimella, älä selaimessa tai julkisessa sovelluksessa. Vaihto säilyttää asiakkaan ja saldon.

REMOX_API_KEY

Käytä JPG-, PNG- tai staattista WebP-kuvaa. Muuta koko ennen lähetystä; API ei skaalaa kuvia.

Koodiesimerkit →

Todennus

Säilytä myönnetty avain palvelimella, älä selaimessa tai julkisessa sovelluksessa. Vaihto säilyttää asiakkaan ja saldon.

Kenttä	Sallittu arvo
X-API-Key	remox_live_… / remox_test_…
Secret / X-Subuid / X-Platform-User / X-RapidAPI-User	—
image_url / Base64 / shadow / refine	—

Koodiesimerkit

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.

Käytä JPG-, PNG- tai staattista WebP-kuvaa. Muuta koko ennen lähetystä; API ei skaalaa kuvia.

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

Pyynnön viite

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

Käytä JPG-, PNG- tai staattista WebP-kuvaa. Muuta koko ennen lähetystä; API ei skaalaa kuvia.

Kenttä	Pakollinen	Sallittu arvo
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 . _ : -

Vastaukset

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

Aikarajat ja uusintayritykset

60 sekunnin jälkeen 504 voi tarkoittaa jatkuvaa tehtävää. Tarkista tila tai toista samalla kuvalla ja Idempotency-Key-arvolla, jotta vältät kaksoisveloituksen.

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

Tili ja krediitit

Krediitit varataan luotaessa, kulutetaan onnistuttaessa ja vapautetaan virheessä tai tehtävän vanhetessa. Synkroninen aikaraja ei vapauta niitä.

Kenttä	Sallittu arvo
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

Virheet

Tarkista errors ja tehtävän tila ennen uusintaa. Säilytä requestId tukea varten; älä kirjaa avainta lokiin.

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

HTTP	errors[].code	Virheet
400	invalid_request, invalid_file	Virheellinen pyyntö
400	invalid_size, invalid_response_format	Virheellinen pyyntö
400	invalid_idempotency_key, invalid_subject	Virheellinen pyyntö
402	insufficient_credits	Riittämättömät krediitit
403	invalid_credentials	Pääsy estetty
403	platform_disabled, platform_paused, scope_denied	Pääsy estetty
404	not_found, upload_not_found	Ei löytynyt
409	idempotency_conflict	Ristiriita tai keskeneräinen tehtävä
409	result_not_ready	Ristiriita tai keskeneräinen tehtävä
410	task_expired, result_expired	Vanhentunut
413	file_too_large	Liian suuri tiedosto
415	invalid_image, animated_image_unsupported	Kuvaa ei tueta
422	image_dimensions_exceeded	Kuvakoko ylitetty
429	rate_limit_exceeded, hourly_quota_exhausted, inflight_limit_exceeded	Pyyntörajat ylitetty
502	upload_failed, upstream_rejected, upstream_unavailable	Ulkoisen palvelun virhe
502	create_result_unknown, remote_service_error, invalid_result, result_unavailable, task_failed, task_timeout	Ulkoisen palvelun virhe
503	service_not_configured, credit_price_not_configured, server_error	Palvelu ei saatavilla
504	sync_timeout	Synkroninen aikaraja

retryable: 429 / 5xx

60 sekunnin jälkeen 504 voi tarkoittaa jatkuvaa tehtävää. Tarkista tila tai toista samalla kuvalla ja Idempotency-Key-arvolla, jotta vältät kaksoisveloituksen.

Yhteensopivuus

Vain yhden avaimen taustanpoisto. Kaikkia remove.bg-toimintoja ei toteuteta. JSON-tulososoitteet ovat REMOX-laajennus.

Pyydä API-käyttöoikeutta →