Документация на API за премахване на фон
Изпратете изображение и получете прозрачен PNG с един API ключ.
https://api.remox.ai/v1.0/removebgБърз старт
Заявка за API достъп →Пазете издадения ключ на сървъра, не в браузър или публично приложение. Смяната запазва клиента и баланса.
REMOX_API_KEYИзползвайте JPG, PNG или статичен WebP. Променете размера преди качване; API не мащабира изображения.
Примери за код →Удостоверяване
Пазете издадения ключ на сървъра, не в браузър или публично приложение. Смяната запазва клиента и баланса.
| Поле | Допустима стойност |
|---|---|
| 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-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/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 за поддръжката; не записвайте ключа.
{
"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, за да избегнете двойно таксуване.
Съвместимост
Само премахване на фон с един ключ. Не всички опции на remove.bg са реализирани. JSON адресите са разширение REMOX.
Заявка за API достъп →