RemBG ব্যাকগ্রাউন্ড রিমুভাল API – ডেভেলপার ডক্স এবং ইন্টিগ্রেশন গাইড
সম্পূর্ণ API অন্বেষণ করুন—আপনার ব্রাউজারে বাস্তব অনুরোধগুলি চালান
প্রতিটি এন্ডপয়েন্ট, প্যারামিটার এবং প্রতিক্রিয়া ব্রাউজ করুন। আপনার API কী দিয়ে অনুরোধ করার চেষ্টা করুন, তারপরে যে কোনো সময় /api/openapi-এ কাঁচা স্পেকটি ধরুন।
ইন্টারেক্টিভ রেফারেন্স চালু করুন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") |
আপনার পরিবেশ সেট আপ করা হচ্ছে: নিশ্চিত করুন যে আপনার প্রোজেক্ট রুটে আপনার API কী সহ একটি .env ফাইল আছে।
প্রয়োজনীয় মডিউল আমদানি করা: @remove-background-ai/rembg.js থেকে rembg ফাংশন আমদানি করে শুরু করুন এবং পরিবেশ ভেরিয়েবলগুলি পরিচালনা করতে dotenv মডিউল।
অগ্রগতি কলব্যাক কনফিগার করা: ফাইল অপারেশনের অগ্রগতি ট্র্যাক করতে লাইব্রেরি অনডাউনলোডপ্রগ্রেস এবং অনআপলোডপ্রগ্রেস কলব্যাক অফার করে। প্রদত্ত উদাহরণে, আমরা এই ইভেন্টগুলি সরাসরি কনসোলে লগ করছি৷
এখন, আসুন একটি নমুনা ব্যবহারকে ঘনিষ্ঠভাবে দেখি:
// 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}। যদি বাদ দেওয়া হয় (এবং পিরিয়ডস্টার্টইউনিক্স ব্যবহার করা হয় না), বর্তমান UTC বছরে ডিফল্ট। |
| month | number (1–12) | ক্যালেন্ডার মাস 1-12 (কীগুলির জন্য ব্যবহৃত ইউটিসি কনভেনশন)। বাদ দেওয়া হলে, বর্তমান UTC মাসে ডিফল্ট। |
| periodStartUnix | number | সেকেন্ডে ইউনিক্স টাইমস্ট্যাম্প: একটি বিলিং উইন্ডোর শুরু৷ ব্যবহারকারী পড়ে:{uid}:app_usage:cycle:{periodStartUnix} এবং api_usage:cycle:…. বছর বা মাসের সাথে একত্রিত করা যাবে না। |
| expand | string | কমা দ্বারা পৃথক পতাকা। বিলিংসাইকেল অবজেক্ট যোগ করতে বিলিং_সাইকেল অন্তর্ভুক্ত করুন: বর্তমান স্ট্রাইপ সময়কাল যখন বিলিং_পিরিয়ড_* রেডিসে বিদ্যমান থাকে, অন্যথায় বর্তমান UTC ক্যালেন্ডার মাসে। এছাড়াও একটি নির্দিষ্ট উইন্ডোর জন্য periodStartUnix এর সাথে কাজ করে। |
| includeBillingCycle | 1 / true | বিলিং_সাইকেল সম্বলিত প্রসারণের মতোই: বিলিং সাইকেল অবজেক্ট অন্তর্ভুক্ত করতে 1 বা সত্যে সেট করুন৷ |
| listBillingCycles | 1 / true | ডেডিকেটেড মোড: listBillingCycles=1 অথবা সত্য রিটার্ন শুধুমাত্র { billingCycles: [...] }। এই ব্যবহারকারীর জন্য সাইকেল কীগুলির জন্য Redis স্ক্যান করে; এই অনুরোধে অন্যান্য ক্যোয়ারী প্যারামিটার উপেক্ষা করা হয়। |
বছর বা মাসের সাথে পিরিয়ডস্টার্টইউনিক্স পাস করবেন না — API 400 রিটার্ন করে। লিস্টবিলিং সাইকেল মোড আলাদা এবং অন্যান্য প্যারাম উপেক্ষা করে।
বিলিং সময়কাল তালিকাভুক্ত করুন
অতীত এবং বর্তমান সাবস্ক্রিপশন উইন্ডোগুলির একটি ড্রপডাউন তৈরি করতে এটি ব্যবহার করুন (প্রতিটি এন্ট্রি হল একটি periodStartUnix যা আপনি periodStartUnix=… দিয়ে ফিরে যেতে পারেন)। পিরিয়ডের শেষ সময় অনুমান করা হয় (পরবর্তী সময়ের শুরু − 1, বা সক্রিয় সময়ের জন্য স্ট্রিপ current_period_end)।
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 | বর্তমান উইন্ডোর শেষ (ইউনিক্স সেকেন্ড), অর্থাৎ পরবর্তী পুনর্নবীকরণের ঠিক আগে — সিঙ্ক করা হলে স্ট্রাইপ current_period_end। সাবস্ক্রিপশন বাতিলের তারিখের মতো নয়। |
| appUsage / apiUsage | অন্তর্ভুক্ত-ক্রেডিট ব্যবহার এই উইন্ডোতে গণনা করা হয়েছে: ওয়েব/সম্পাদক (অ্যাপ) বনাম API কী (এপিআই)। useIncludedCredits তাদের যোগফলের সমান। |
| includedCredits | আপনার অন্তর্ভুক্ত (পরিকল্পনা) ক্রেডিট ভাতা Redis-এ সংরক্ষিত (শীর্ষ-স্তরের ক্রেডিট হিসাবে একই ধারণা)। |
| prepaidCredits | প্রিপেইড (ক্রয়কৃত) ব্যালেন্স; প্রতিটি বিলিং সময়কাল রিসেট করে না। |
| usedIncludedCredits | উইন্ডোতে মোট অন্তর্ভুক্ত ব্যবহার (অ্যাপ + API)। প্রিপেইড খরচ এখানে যোগ করা হয় না. |
| remainingIncludedCredits | সর্বোচ্চ(0, অন্তর্ভুক্ত ক্রেডিট − ব্যবহৃত অন্তর্ভুক্ত ক্রেডিট)। |
| stripeBillingSynced | সত্য যখন Redis-এ স্ট্রাইপ থেকে বিলিং_পিরিয়ড_স্টার্ট/শেষ হয় যাতে উইন্ডোটি আপনার সদস্যতার সাথে মেলে; মিথ্যা মানে এই ব্লকের জন্য API একটি UTC ক্যালেন্ডার মাসে ফিরে এসেছে। |
যতক্ষণ না স্ট্রাইপ ওয়েবহুক ব্যবহারকারীর জন্য বিলিং সময়কাল লিখছে, স্ট্রাইপবিলিং সিঙ্ক করা মিথ্যা হতে পারে এবং বিলিংসাইকেল উইন্ডো UTC ক্যালেন্ডার মাস অনুসরণ করে৷ সিঙ্ক করার পরে, চিত্র API-এর ব্যবহারের সীমা একই চক্র কীগুলির সাথে সারিবদ্ধ হয়৷
"পরবর্তী পুনর্নবীকরণের আগে ব্যবহৃত ক্রেডিট" এর জন্য, expand=billing_cycle এর সাথে কল করুন এবং পুনর্নবীকরণ সীমানা হিসাবে billingCycle.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 বাদ দিলে, billingCycle অনুপস্থিত থাকে।
{
"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 সত্য হয়, তখন BillingCycle ব্যাকগ্রাউন্ড-রিমুভাল API-এ প্রয়োগের সাথে মেলে। মিথ্যা হলে, ক্যালেন্ডার মাসের ফিল্ডের উপর নির্ভর করুন বা Redis-এ webhooks বিলিং_পিরিয়ড_* পূরণ না হওয়া পর্যন্ত অপেক্ষা করুন।
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