תיעוד 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

לאחר 60 שניות, 504 עשוי להצביע על משימה פעילה. בדקו מצב או נסו שוב עם אותה תמונה ואותו Idempotency-Key למניעת חיוב כפול.

תאימות

הסרת רקע עם מפתח יחיד בלבד. לא כל אפשרויות remove.bg נתמכות. כתובות תוצאה JSON הן הרחבת REMOX.

בקשת גישה ל-API →