توثيق API لإزالة الخلفية

أرسل صورة واحصل على PNG شفافة باستخدام مفتاح API واحد.

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

المهلة وإعادة المحاولة

بعد 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=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 →