RemBG Background Removal API – Developer Docs & Integration Guide
Preskúmajte úplné rozhranie API – spúšťajte skutočné požiadavky vo svojom prehliadači
Prehľadávajte každý koncový bod, parametre a odpovede. Vyskúšajte požiadavky pomocou kľúča API a potom kedykoľvek získajte surovú špecifikáciu v /api/openapi.
Spustiť interaktívnu referenciuInštalácia 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") |
Nastavenie prostredia: Uistite sa, že máte v koreňovom adresári projektu súbor .env obsahujúci váš kľúč API.
Import potrebných modulov: Začnite importovaním funkcie rembg z @remove-background-ai/rembg.js a modulu dotenv na spracovanie premenných prostredia.
Konfigurácia spätných volaní o priebehu: Knižnica ponúka spätné volania onDownloadProgress a onUploadProgress na sledovanie priebehu operácií so súbormi. V uvedenom príklade zaznamenávame tieto udalosti priamo do konzoly.
Teraz sa pozrime bližšie na príklad použitia:
// 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();
});
Pamätajte, že funkciu čistenia možno volať, ak chcete po odstránení pozadia odstrániť spracovaný obrázok z disku.
Zobrazuje sa indikátor priebehu
Pri integrácii služby odstraňovania na pozadí je často užitočné poskytnúť používateľom spätnú väzbu o priebehu ich žiadosti o odovzdanie alebo stiahnutie. Aby ste to uľahčili, môžete definovať svoje vlastné spätné volania onDownloadProgress a onUploadProgress. Obidve tieto spätné volania akceptujú AxiosProgressEvent ako parameter udalosti. Ako požiadavka pokračuje, tieto spätné volania sa vyvolávajú viackrát, čo vám umožňuje napríklad zobraziť indikátor priebehu a upraviť jeho dĺžku na základe priebehu.
(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)
Použitie členstva a kreditov
Vráti štítok vášho plánu, zahrnuté a predplatené zostatky kreditu a využitie. Môžete sa dotazovať podľa kalendárneho mesiaca UTC (staršie), podľa fakturačného obdobia zarovnaného s pruhmi (na monitorovanie prostredníctvom obnovenia) alebo vypísať zoznam známych fakturačných období. Overte sa iba pomocou kľúča API.
Schémy, príklady a skúšobnú konzolu nájdete v rovnakom koncovom bode v úplnej referencii: Otvoriť dokumenty API
koncový bod
GET https://www.rembg.com/api/membership-usageAutentifikácia
Pošlite svoj kľúč API: hlavička x-api-key: YOUR_API_KEY_HERE (vytvorte a spravujte kľúče vo svojom profile na rembg.com).
Parametre dopytu
| Parameter | Typ | Popis |
|---|---|---|
| year | number | Kalendárny rok (1–9999). S mesiacom číta Redis kľúče user:{uid}:app_usage:{year}:{month}. Ak sa vynechá (a nepoužije sa periodStartUnix), predvolene sa použije aktuálny rok UTC. |
| month | number (1–12) | Kalendárny mesiac 1–12 (pre kľúče sa používa konvencia UTC). Ak sa vynechá, predvolene sa použije aktuálny mesiac UTC. |
| periodStartUnix | number | Časová pečiatka systému Unix v sekundách: začiatok fakturačného obdobia. Číta user:{uid}:app_usage:cycle:{periodStartUnix} a api_usage:cycle:…. Nemožno kombinovať s rokom alebo mesiacom. |
| expand | string | Príznaky oddelené čiarkami. Zahrnutím billing_cycle pridáte objekt billingCycle: aktuálne obdobie Stripe, keď v Redis existuje billing_period_*, inak aktuálny kalendárny mesiac UTC. Tiež funguje s periodStartUnix pre konkrétne okno. |
| includeBillingCycle | 1 / true | Rovnaké ako rozbalenie obsahujúce billing_cycle: nastavte na 1 alebo true, aby ste zahrnuli objekt billingCycle. |
| listBillingCycles | 1 / true | Vyhradený režim: listBillingCycles=1 alebo true vráti iba { billingCycles: [...] }. Skenuje Redis kľúče cyklov pre tohto používateľa; ostatné parametre dopytu sú pri tejto požiadavke ignorované. |
Nezadávajte periodStartUnix spolu s rokom alebo mesiacom – API vráti 400. Režim listBillingCycles je samostatný a ignoruje ostatné parametre.
Zoznam fakturačných období
Použite toto na vyplnenie rozbaľovacieho zoznamu minulých a aktuálnych okien predplatného (každá položka je periodStartUnix, ktorú môžete vrátiť pomocou periodStartUnix=…). Časy ukončenia obdobia sú odvodené (začiatok nasledujúceho obdobia − 1, alebo Stripe current_period_end pre aktívne obdobie).
curl --location 'https://www.rembg.com/api/membership-usage?listBillingCycles=1' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Príklad odpovede
{
"billingCycles": [
{
"periodStartUnix": 1774268612,
"periodEndUnix": 1776947012,
"appUsage": 120,
"apiUsage": 880
}
]
}Najnovšie obdobie zoradené ako prvé. Bodka sa zobrazí, ak existuje kľúč používania cyklu alebo ak je to aktuálny billing_period_start z webhookov Stripe.
Objekt billingCycle
Prítomné, keď je nastavené rozbalenie zahŕňa billing_cycle alebo includeBillingCycle. Použite ho pre informačné panely: hranica obnovenia, použitie v okne a zostávajúce zahrnuté kredity.
| pole | Popis |
|---|---|
| periodStartUnix | Začiatok fakturačného obdobia (unix sekúnd). Zodpovedá Stripe current_period_start, keď je účet synchronizovaný. |
| periodEndUnix | Koniec aktuálneho okna (unix sekundy), t. j. tesne pred ďalším obnovením — Stripe current_period_end pri synchronizácii. Nie je to isté ako dátum zrušenia predplatného. |
| appUsage / apiUsage | Využitie zahrnutého kreditu započítané v tomto okne: web/editor (aplikácia) verzus kľúč API (api). usedIncludedCredits sa rovná ich súčtu. |
| includedCredits | Zahrnutý kredit (plánu) uložený v Redis (rovnaký nápad ako kredity najvyššej úrovne). |
| prepaidCredits | Predplatený (nakúpený) zostatok; neresetuje každé fakturačné obdobie. |
| usedIncludedCredits | Celková zahrnutá spotreba v okne (aplikácia + API). Predplatená spotreba sa tu nepripočítava. |
| remainingIncludedCredits | max(0, zahrnuté kredity − usedIncludedCredits) pre túto snímku. |
| stripeBillingSynced | true, keď Redis má billing_period_start/end od Stripe, takže okno zodpovedá vášmu predplatnému; false znamená, že rozhranie API sa pre tento blok vrátilo na kalendárny mesiac UTC. |
Kým webhooky Stripe nenapíšu pre používateľa fakturačné obdobia, stripeBillingSynced môže byť nepravdivé a okno billingCycle bude nasledovať po kalendárnom mesiaci UTC. Po synchronizácii sa limity použitia v rozhraní API pre obrázky zosúladia s rovnakými kľúčmi cyklu.
Pre „kredity použité pred ďalším obnovením“ zavolajte pomocou expand=billing_cycle a ako hranicu obnovenia použite billingCycle.periodEndUnix, billingCycle.usedIncludedCredits (alebo appUsage + apiUsage) a billingCycle.remainingIncludedCredits. Ak chcete celkový disponibilný zostatok, pridajte predplatené kredity.
Príklady (cURL)
Použitie pre konkrétny kalendárny mesiac UTC
curl --location 'https://www.rembg.com/api/membership-usage?year=2026&month=3' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Aktuálny fakturačný cyklus + úplný blok fakturačného cyklu (zarovnané s obnovením pri synchronizácii)
# 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'
Jedno historické fakturačné okno podľa začiatku obdobia (zo zoznamuBillingCycles alebo Stripe)
# 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'
Príklad JSON (s fakturačným cyklom)
Najvyššia úroveň app_usage a api_usage vždy odráža buď požadovaný kalendárny mesiac, alebo, keď je nastavený periodStartUnix, počítadlá daného cyklu. Keď je expand=billing_cycle vynechaný, billingCycle chýba.
{
"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
}
}Keď je hodnota stripeBillingSynced pravdivá, billingCycle sa zhoduje s presadzovaním v rozhraní API na odstránenie na pozadí. Ak je nepravda, spoliehajte sa na polia kalendárneho mesiaca alebo počkajte, kým webhooky nezaplnia billing_period_* v Redis.
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