RemBG پس منظر ہٹانے کا API – ڈویلپر دستاویزات اور انٹیگریشن گائیڈ
مکمل API دریافت کریں—اپنے براؤزر میں حقیقی درخواستیں چلائیں
ہر اختتامی نقطہ، پیرامیٹرز، اور جوابات کو براؤز کریں۔ اپنی API کلید کے ساتھ درخواستیں آزمائیں، پھر کسی بھی وقت /api/openapi پر raw spec حاصل کریں۔
انٹرایکٹو حوالہ شروع کریںrembg.js کی تنصیب
npm i @remove-background-ai/rembg.js
API Reference for rembg.js
@remove-background-ai/rembg.js is a zero-config Node.js wrapper for the free Rembg API, enabling background removal with simple, customizable parameters.
Parameters for RemBG.js
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| apiKey | string | Required | – | Your Rembg API key |
| inputImage | string | Buffer | { base64: string } | Required | – | Image file, buffer, or base64 payload |
| onDownloadProgress | (event) => void | Optional | – | Hook for upload progress events |
| onUploadProgress | (event) => void | Optional | – | Hook for download progress events |
| options.format | webp (default) | png | Optional | webp | Specifies the output image format. Either "webp" (default) or "png" |
| options.returnBase64 | boolean | Optional | false | Return Base64 string instead of file |
| options.returnMask | boolean | Optional | false | Return only the alpha mask |
| options.w | number | Optional | – | Target width (maintains aspect ratio) |
| options.h | number | Optional | – | Target height (maintains aspect ratio) |
| options.exact_resize | boolean | Optional | false | Force exact width × height (may distort) |
| options.angle | number | Optional | 0 | Rotation angle in degrees |
| options.expand | boolean | Optional | true | Add padding so rotated images aren’t cropped |
| options.bg_color | string | Optional | - | Optional solid background color in hex (e.g. #FFFFFFFF) or named color (e.g. "red", "blue") |
اپنا ماحول ترتیب دینا: یقینی بنائیں کہ آپ کے پروجیکٹ روٹ میں ایک .env فائل ہے جس میں آپ کی API کلید ہے۔
ضروری ماڈیولز درآمد کرنا: ماحول کے متغیرات کو سنبھالنے کے لیے @remove-background-ai/rembg.js اور dotenv ماڈیول سے rembg فنکشن درآمد کرکے شروع کریں۔
پیش رفت کال بیکس کو ترتیب دینا: لائبریری فائل آپریشنز کی پیشرفت کو ٹریک کرنے کے لیے ڈاؤن لوڈ پروگریس اور آن اپ لوڈ پروگریس کال بیکس پیش کرتی ہے۔ فراہم کردہ مثال میں، ہم ان واقعات کو براہ راست کنسول میں لاگ ان کر رہے ہیں۔
اب، آئیے ایک نمونے کے استعمال پر گہری نظر ڈالتے ہیں:
// script.mjs file
import { rembg } from '@remove-background-ai/rembg.js';
import dotenv from 'dotenv';
// Load environment variables from .env file
dotenv.config();
// API_KEY will be loaded from the .env file
const API_KEY = process.env.API_KEY;
// log upload and download progress
const onDownloadProgress = console.log;
const onUploadProgress = console.log;
rembg({
apiKey: API_KEY,
inputImage: './input.png', //inputImage can be one of these: string | Buffer | { base64: string };
onDownloadProgress,
onUploadProgress
}).then(({ outputImagePath, cleanup }) => {
console.log('✅🎉 background removed and saved under path=', outputImagePath);
// if called, it will cleanup (remove from disk) your removed background image
// cleanup();
});
یاد رکھیں، اگر آپ بیک گراؤنڈ ہٹانے کے بعد پروسیس شدہ تصویر کو اپنی ڈسک سے ہٹانا چاہتے ہیں تو کلین اپ فنکشن کو کال کیا جا سکتا ہے۔
پیش رفت بار دکھا رہا ہے
پس منظر ہٹانے کی خدمت کو مربوط کرتے وقت، صارفین کو ان کی اپ لوڈ یا ڈاؤن لوڈ کی درخواست کی پیشرفت پر تاثرات فراہم کرنا اکثر فائدہ مند ہوتا ہے۔ اس کی سہولت کے لیے، آپ اپنی اپنی onDownloadProgress اور onUploadProgress کال بیکس کی وضاحت کر سکتے ہیں۔ یہ دونوں کال بیکس AxiosProgressEvent کو ایونٹ پیرامیٹر کے طور پر قبول کرتے ہیں۔ جیسے جیسے درخواست آگے بڑھتی ہے، ان کال بیکس کو متعدد بار طلب کیا جاتا ہے، مثال کے طور پر، آپ کو ایک پروگریس بار ڈسپلے کرنے اور پیش رفت کی بنیاد پر اس کی لمبائی کو ایڈجسٹ کرنے کی اجازت دیتا ہے۔
(base) root@DESKTOP-C0Q8KK7:~/rembg.js-test# node index.mjs
{
loaded: 65687,
total: 68474,
progress: 0.9592984198381868, <---- @95% progress
bytes: 65687,
rate: undefined,
estimated: undefined,
upload: true <---- upload progress
}
{
loaded: 68474,
total: 68474,
progress: 1, <---- @100% progress
bytes: 2787,
rate: undefined,
estimated: undefined,
upload: true <---- upload progress
}
{
loaded: 1002,
total: 68824,
progress: 0.014558874811112402, <---- @1% progress
bytes: 1002,
rate: undefined,
estimated: undefined,
download: true <---- download progress
}
{
loaded: 68824,
total: 68824,
progress: 1, <---- @100% progress
bytes: 67822,
rate: undefined,
estimated: undefined,
download: true <---- download progress
}
✅🎉 background removed and saved under path=/tmp/rembg--3339-DBqqeJ2eOs4D-.png
Curl
# Full example: upload an image and remove its background with all optional parameters curl -X POST "https://api.rembg.com/rmbg" -H "x-api-key: YOUR_API_KEY_HERE" # your personal API key -F "image=@/path/to/image.jpg" # input image file -F "format=webp" # output format: webp (default) or png -F "w=800" # target width in pixels (maintains aspect ratio unless exact_resize=true) -F "h=600" # target height in pixels -F "exact_resize=false" # true = force exact w × h, may distort -F "mask=false" # true = return only the alpha mask instead of full image -F "bg_color=#ffffffff" # optional solid background color (RGBA hex) -F "angle=0" # rotate the image by given degrees after processing -F "expand=true" # add padding so rotated images don’t get cropped
HTTP
POST /rmbg HTTP/1.1
Host: api.rembg.com
x-api-key: YOUR_API_KEY_HERE
Content-Type: multipart/form-data; boundary=----BOUNDARY
------BOUNDARY
Content-Disposition: form-data; name="image"; filename="image.jpg"
Content-Type: image/jpeg
<binary data of your image goes here>
------BOUNDARY
Content-Disposition: form-data; name="format"
webp
------BOUNDARY
Content-Disposition: form-data; name="w"
800
------BOUNDARY
Content-Disposition: form-data; name="h"
600
------BOUNDARY
Content-Disposition: form-data; name="exact_resize"
false
------BOUNDARY
Content-Disposition: form-data; name="mask"
false
------BOUNDARY
Content-Disposition: form-data; name="bg_color"
#ffffffff
------BOUNDARY
Content-Disposition: form-data; name="angle"
0
------BOUNDARY
Content-Disposition: form-data; name="expand"
true
------BOUNDARY--
Python Requests
import requests
# Endpoint URL for the background-removal API
url = "https://api.rembg.com/rmbg"
# Required API key header
headers = {
"x-api-key": "YOUR_API_KEY_HERE"
}
# The image file to process (opened in binary mode)
files = {
"image": open("/path/to/image.jpg", "rb")
}
# Optional form fields supported by your backend.
# Adjust values as needed; any of these can be omitted.
data = {
"format": "webp", # Output format: "webp" (default) or "png"
"w": 800, # Target width (maintains aspect ratio unless exact_resize is true)
"h": 600, # Target height
"exact_resize": "false", # "true" forces exact w×h, may distort
"mask": "false", # "true" returns only the alpha mask
"bg_color": "#ffffffff", # Optional solid background color (RGBA hex)
"angle": 0, # Rotation angle in degrees
"expand": "true", # Add padding so rotated images aren’t cropped
}
# Send the POST request with headers, file, and extra form data
response = requests.post(url, headers=headers, files=files, data=data)
# Handle the response
if response.status_code == 200:
# Save the processed image to disk
with open("output.webp", "wb") as f:
f.write(response.content)
print("Background removed successfully → saved as output.webp")
else:
# Print error details if the request failed
print("Error:", response.status_code, response.text)
رکنیت اور کریڈٹ کا استعمال
آپ کا پلان لیبل، شامل اور پری پیڈ کریڈٹ بیلنس، اور استعمال لوٹاتا ہے۔ آپ UTC کیلنڈر مہینے (وراثت)، پٹی سے منسلک بلنگ پیریڈ (تجدید کے ذریعے نگرانی کے لیے) کے حساب سے استفسار کر سکتے ہیں، یا معلوم بلنگ پیریڈز کی فہرست بنا سکتے ہیں۔ صرف اپنی API کلید سے تصدیق کریں۔
اسکیموں، مثالوں، اور ٹرائی کنسول کے لیے، مکمل حوالہ میں وہی اختتامی نقطہ دیکھیں: API دستاویزات کھولیں
اختتامی نقطہ
GET https://www.rembg.com/api/membership-usageتوثیق
اپنی API کلید بھیجیں: ہیڈر x-api-key: YOUR_API_KEY_HERE (rembg.com پر اپنے پروفائل میں کیز بنائیں اور ان کا نظم کریں)۔
استفسار کے پیرامیٹرز
| پیرامیٹر | قسم | تفصیل |
|---|---|---|
| year | number | کیلنڈر سال (1-9999)۔ مہینے کے ساتھ، Redis کیز صارف:{uid}:app_usage:{year}:{month} پڑھتا ہے۔ اگر چھوڑ دیا جاتا ہے (اور periodStartUnix استعمال نہیں کیا جاتا ہے)، موجودہ UTC سال سے پہلے سے طے شدہ۔ |
| month | number (1–12) | کیلنڈر مہینہ 1-12 (کیز کے لیے استعمال ہونے والا یو ٹی سی کنونشن)۔ اگر چھوڑ دیا جائے تو موجودہ UTC مہینے کے لیے ڈیفالٹ۔ |
| periodStartUnix | number | یونکس ٹائم اسٹیمپ سیکنڈوں میں: بلنگ ونڈو کا آغاز۔ صارف کو پڑھتا ہے:{uid}:app_usage:cycle:{periodStartUnix} اور api_usage:cycle:…. سال یا مہینے کے ساتھ نہیں مل سکتا۔ |
| expand | string | کوما سے الگ کردہ جھنڈے۔ بلنگ سائیکل آبجیکٹ کو شامل کرنے کے لیے بلنگ_سائیکل شامل کریں: موجودہ پٹی کی مدت جب بلنگ_پیریوڈ_* Redis میں موجود ہو، بصورت دیگر موجودہ UTC کیلنڈر مہینہ۔ ایک مخصوص ونڈو کے لیے periodStartUnix کے ساتھ بھی کام کرتا ہے۔ |
| includeBillingCycle | 1 / true | بلنگ_سائیکل پر مشتمل توسیع کی طرح: بلنگ سائیکل آبجیکٹ کو شامل کرنے کے لیے 1 یا درست پر سیٹ کریں۔ |
| listBillingCycles | 1 / true | وقف شدہ وضع: listBillingCycles=1 یا حقیقی واپسی صرف { billingCycles: [...] }۔ اس صارف کے لیے سائیکل کیز کے لیے Redis کو اسکین کرتا ہے۔ اس درخواست پر سوال کے دیگر پیرامیٹرز کو نظر انداز کر دیا گیا ہے۔ |
پیریڈ سٹارٹ یونکس کو سال یا مہینے کے ساتھ ساتھ نہ گزریں — API 400 لوٹاتا ہے۔ listBillingCycles موڈ الگ ہے اور دوسرے پیرامز کو نظر انداز کرتا ہے۔
بلنگ کے دورانیے کی فہرست بنائیں
ماضی اور موجودہ سبسکرپشن ونڈوز کے ڈراپ ڈاؤن کو آباد کرنے کے لیے اس کا استعمال کریں (ہر اندراج ایک periodStartUnix ہے جسے آپ periodStartUnix=… کے ساتھ واپس پاس کر سکتے ہیں)۔ مدت کے اختتامی اوقات کا اندازہ لگایا جاتا ہے (اگلی مدت کا آغاز − 1، یا فعال مدت کے لیے اسٹرائپ کرنٹ_پیریوڈ_اینڈ)۔
curl --location 'https://www.rembg.com/api/membership-usage?listBillingCycles=1' \ --header 'x-api-key: YOUR_API_KEY_HERE'
مثال کا جواب
{
"billingCycles": [
{
"periodStartUnix": 1774268612,
"periodEndUnix": 1776947012,
"appUsage": 120,
"apiUsage": 880
}
]
}پہلے تازہ ترین مدت کو ترتیب دیا گیا۔ ایک مدت ظاہر ہوتی ہے اگر کوئی سائیکل استعمال کی کلید ہے یا اگر یہ اسٹرائپ ویب ہکس سے موجودہ بلنگ_پیریوڈ_شروع ہے۔
بلنگ سائیکل آبجیکٹ
اس وقت پیش کریں جب توسیع میں بلنگ_سائیکل شامل ہو یا بلنگ سائکل سیٹ ہو۔ اسے ڈیش بورڈز کے لیے استعمال کریں: تجدید کی حد، ونڈو میں استعمال، اور باقی شامل کریڈٹس۔
| فیلڈ | تفصیل |
|---|---|
| periodStartUnix | بلنگ ونڈو کا آغاز (یونکس سیکنڈز)۔ اکاؤنٹ کے مطابقت پذیر ہونے پر اسٹرائپ current_period_start سے مماثل ہے۔ |
| periodEndUnix | موجودہ ونڈو کا اختتام (یونکس سیکنڈز)، یعنی اگلی تجدید سے ٹھیک پہلے — مطابقت پذیر ہونے پر کرنٹ_پیریوڈ_اینڈ کو پٹی لگائیں۔ سبسکرپشن منسوخی کی تاریخ جیسی نہیں ہے۔ |
| appUsage / apiUsage | اس ونڈو میں شامل کریڈٹ استعمال کا شمار: ویب/ایڈیٹر (ایپ) بمقابلہ API کلید (api)۔ UsedIncludedCredits ان کی رقم کے برابر ہے۔ |
| includedCredits | آپ کا شامل کردہ (پلان) کریڈٹ الاؤنس جیسا کہ Redis میں ذخیرہ کیا گیا ہے (اعلی سطح کے کریڈٹ کے طور پر ایک ہی خیال)۔ |
| prepaidCredits | پری پیڈ (خریدا ہوا) بیلنس؛ ہر بلنگ کی مدت کو دوبارہ ترتیب نہیں دیتا ہے۔ |
| usedIncludedCredits | ونڈو میں کل شامل استعمال (ایپ + API)۔ پری پیڈ کھپت یہاں شامل نہیں کی گئی ہے۔ |
| remainingIncludedCredits | زیادہ سے زیادہ(0، شامل کریڈٹ − استعمال کیے گئے شامل کریڈٹ)۔ |
| stripeBillingSynced | درست ہے جب Redis کے پاس اسٹرائپ سے بلنگ_پیریوڈ_شروع/اختتام ہوتا ہے تاکہ ونڈو آپ کے سبسکرپشن سے مماثل ہو۔ غلط کا مطلب ہے کہ API اس بلاک کے لیے UTC کیلنڈر مہینے میں واپس آ گیا۔ |
جب تک اسٹرائپ ویب ہکس نے صارف کے لیے بلنگ کی مدت نہیں لکھی ہے، stripeBillingSynced غلط ہو سکتا ہے اور بلنگ سائیکل ونڈو UTC کیلنڈر مہینے کی پیروی کرتی ہے۔ مطابقت پذیری کے بعد، تصویر API پر استعمال کی حدیں اسی سائیکل کیز کے ساتھ سیدھ میں آتی ہیں۔
"اگلی تجدید سے پہلے استعمال شدہ کریڈٹس" کے لیے، expand=billing_cycle کے ساتھ کال کریں اور بلنگ سائکل.periodEndUnix کو تجدید کی حد کے طور پر استعمال کریں، billingCycle.usedIncludedCredits (یا appUsage + apiUsage) اور billingCycle.remaining اگر آپ کل ڈسپوزایبل بیلنس چاہتے ہیں تو پری پیڈ کریڈٹس شامل کریں۔
مثالیں (cURL)
مخصوص UTC کیلنڈر مہینے کے لیے استعمال
curl --location 'https://www.rembg.com/api/membership-usage?year=2026&month=3' \ --header 'x-api-key: YOUR_API_KEY_HERE'
موجودہ بلنگ سائیکل + مکمل بلنگ سائیکل بلاک (تجدید موافقت پذیر ہونے پر)
# Current subscription window + usage (renewal-aligned when Stripe is synced) curl --location 'https://www.rembg.com/api/membership-usage?expand=billing_cycle' \ --header 'x-api-key: YOUR_API_KEY_HERE'
مدت کے لحاظ سے ایک تاریخی بلنگ ونڈو شروع (فہرست بلنگ سائیکل یا پٹی سے)
# Specific billing period by Stripe period start (unix seconds) curl --location 'https://www.rembg.com/api/membership-usage?periodStartUnix=1774268612&expand=billing_cycle' \ --header 'x-api-key: YOUR_API_KEY_HERE'
مثال JSON (بلنگ سائیکل کے ساتھ)
ٹاپ لیول ایپ_استعمال اور api_usage ہمیشہ یا تو درخواست کردہ کیلنڈر مہینے کی عکاسی کرتے ہیں یا، جب دورانیہ اسٹارٹ یونکس سیٹ ہوتا ہے، اس سائیکل کے کاؤنٹر۔ جب expand=billing_cycle کو چھوڑ دیا جاتا ہے، بلنگ سائیکل غائب ہوتا ہے۔
{
"membership": "Premium-20000",
"credits": 18500,
"prepaidCredits": 2000,
"app_usage": 8500,
"api_usage": 10000,
"billingCycle": {
"periodStartUnix": 1740441600,
"periodEndUnix": 1743033599,
"appUsage": 4200,
"apiUsage": 5100,
"includedCredits": 18500,
"prepaidCredits": 2000,
"usedIncludedCredits": 9300,
"remainingIncludedCredits": 9200,
"stripeBillingSynced": true
}
}جب stripeBillingSynced درست ہے، بلنگ سائکل پس منظر ہٹانے والے API پر نفاذ سے میل کھاتا ہے۔ غلط ہونے پر، کیلنڈر کے مہینے کی فیلڈز پر انحصار کریں یا Redis میں webhooks بلنگ_period_* کو آباد کرنے تک انتظار کریں۔
Error Responses
All error responses return a JSON body with a status field matching the HTTP status code.
Multiple Validation Errors Response
HTTP/1.1 400 Bad Request
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"error": "Multiple validation errors",
"details": [
{ "field": "w", "message": "'w' must be an integer, got: 'abc'" },
{ "field": "angle", "message": "'angle' must be between -360 and 360 degrees, got: 500.0" }
],
"status": 400
}Error Reference
| Scenario | Status | Error Message |
|---|---|---|
| No image provided | 400 | No image file provided. Please include an 'image' field in your form data. |
| No file selected | 400 | No file selected. Please choose an image file to upload. |
| Unsupported file type | 400 | File type '.exe' is not supported. Allowed formats: webp, bmp, png, jpg, jpeg |
| Corrupt image | 400 | File does not appear to be a valid image (invalid file signature) |
| Empty file (0 bytes) | 400 | Uploaded file is empty (0 bytes). |
| File too large | 400 | File size (55.2 MB) exceeds the maximum allowed size of 50 MB. |
| Image too wide | 400 | Image width (12000px) exceeds the maximum allowed width of 10000px. |
| Image too tall | 400 | Image height (15000px) exceeds the maximum allowed height of 10000px. |
| Bad w or h value | 400 | 'w' must be an integer, got: 'abc' |
| w or h out of range | 400 | 'w' must be at least 1, got: -5 |
| w or h above max | 400 | 'w' must be at most 10000, got: 15000 |
| Bad angle | 400 | 'angle' must be a number, got: 'ninety' |
| Angle out of range | 400 | 'angle' must be between -360 and 360 degrees, got: 500.0 |
| Bad output format | 400 | Invalid format 'gif'. Allowed formats: PNG, JPEG, WEBP, BMP |
| Bad bg_color | 400 | Invalid color format '#12345'. Use hex format: #RGB, #RGBA, #RRGGBB, or #RRGGBBAA |
| mask + bg_color conflict | 400 | Cannot use 'mask=true' together with 'bg_color'. Choose one or the other. |
| Email not verified | 403 | Email address not verified – please check your inbox |
| Invalid API key | 401 | invalid api key |
| Both API key and user token sent | 400 | This is a mistake: Cannot use both API key and user token |
| Rate limit exceeded (short-term) | 429 | You're making requests too quickly, Please Upgrade or slow down. |
| Rate limit exceeded (daily, anonymous) | 429 | You've reached your daily limit. Please sign up for more access. |
| Rate limit exceeded (monthly, authenticated) | 429 | You've reached your monthly limit. Consider purchasing more credits. |
Error Handling Guidelines
- Check HTTP status code 400 to identify validation errors
- Parse the
errorfield for the error message - Check for the
detailsarray when handling multiple validation errors - Use the
fieldproperty to map errors to specific request parameters