مستندات API حذف پس‌زمینه

با یک کلید API تصویر بفرستید و PNG شفاف دریافت کنید.

POSThttps://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	—

نمونه کد

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

مهلت و تلاش مجدد

پس از ۶۰ ثانیه، 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

حساب و اعتبار

اعتبار هنگام ایجاد رزرو، پس از موفقیت مصرف و در شکست یا انقضای کار آزاد می‌شود. پایان مهلت همگام به‌تنهایی آن را آزاد نمی‌کند.

فیلد	مقدار مجاز
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

سازگاری

فقط حذف پس‌زمینه با یک کلید. همه گزینه‌های remove.bg پیاده‌سازی نشده‌اند. نشانی نتیجه JSON افزونه REMOX است.

درخواست دسترسی API →