RemBG-API zur Hintergrundentfernung – Entwicklerdokumentation & Integrationsleitfaden
Die ganze API entdecken — echte Anfragen im Browser
Alle Endpunkte, Parameter und Antworten. Anfragen mit Ihrem API-Schlüssel testen — die Rohspezifikation finden Sie jederzeit unter /api/openapi.
Interaktive Referenz startenInstallation von 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") |
Einrichten Ihrer Umgebung: Stellen Sie sicher, dass Sie eine .env-Datei im Stammverzeichnis Ihres Projekts haben, die Ihren API-Schlüssel enthält.
Importieren der notwendigen Module: Beginnen Sie mit dem Import der rembg-Funktion von @remove-background-ai/rembg.js und dem dotenv-Modul zur Handhabung von Umgebungsvariablen.
Konfigurieren von Fortschritts-Callbacks: Die Bibliothek bietet onDownloadProgress- und onUploadProgress-Callbacks zur Verfolgung des Fortschritts von Dateioperationen. Im bereitgestellten Beispiel loggen wir diese Ereignisse direkt in die Konsole.
Jetzt werfen wir einen genaueren Blick auf ein Beispiel:
// 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();
});
Denken Sie daran, die Aufräumfunktion kann aufgerufen werden, wenn Sie das bearbeitete Bild nach der Entfernung des Hintergrunds von Ihrer Festplatte entfernen möchten.
Anzeigen der Fortschrittsleiste
Bei der Integration eines Dienstes zur Entfernung von Hintergründen ist es oft vorteilhaft, den Benutzern Feedback zum Fortschritt ihrer Upload- oder Download-Anfrage zu geben. Um dies zu erleichtern, können Sie Ihre eigenen onDownloadProgress- und onUploadProgress-Callbacks definieren. Beide Callbacks akzeptieren AxiosProgressEvent als Event-Parameter. Während die Anfrage fortschreitet, werden diese Callbacks mehrmals aufgerufen, sodass Sie beispielsweise eine Fortschrittsleiste anzeigen und ihre Länge basierend auf dem Fortschritt anpassen können.
(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)
Mitgliedschaft & Guthaben
Liefert Tarifbezeichnung, inkludierte und Prepaid-Guthaben sowie Nutzung. Abfrage nach UTC-Kalendermonat (bestehend), nach Stripe-abgestimmter Abrechnungsperiode (Monitoring bis zur Verlängerung) oder Liste bekannter Perioden. Authentifizierung ausschließlich mit API-Schlüssel.
Schemas, Beispiele und eine Try-it-Konsole finden Sie in der vollständigen Referenz für denselben Endpoint: API-Dokumentation öffnen
Endpoint
GET https://www.rembg.com/api/membership-usageAuthentifizierung
API-Schlüssel senden: Header x-api-key: IHR_API_SCHLUESSEL (Erstellung und Verwaltung im Profil auf rembg.com).
Abfrageparameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| year | number | Kalenderjahr (1–9999). Mit month werden Redis-Schlüssel user:{uid}:app_usage:{year}:{month} gelesen. Wenn weggelassen (und kein periodStartUnix), Standard: aktuelles UTC-Jahr. |
| month | number (1–12) | Kalendermonat 1–12 (UTC-Konvention für Schlüssel). Wenn weggelassen: aktueller UTC-Monat. |
| periodStartUnix | number | Unix-Zeitstempel in Sekunden: Start eines Abrechnungsfensters. Liest user:{uid}:app_usage:cycle:{periodStartUnix} und api_usage:cycle:…. Nicht kombinierbar mit year oder month. |
| expand | string | Kommagetrennte Flags. billing_cycle ergänzt ein billingCycle-Objekt: aktuelle Stripe-Periode wenn billing_period_* in Redis existiert, sonst aktueller UTC-Kalendermonat. Funktioniert auch mit periodStartUnix für ein bestimmtes Fenster. |
| includeBillingCycle | 1 / true | Wie expand mit billing_cycle: Wert 1 oder true schaltet das billingCycle-Objekt ein. |
| listBillingCycles | 1 / true | Sondermodus: listBillingCycles=1 oder true liefert nur { billingCycles: [...] }. SCAN über Redis-Cycle-Schlüssel des Nutzers; andere Parameter werden bei dieser Anfrage ignoriert. |
periodStartUnix nicht zusammen mit year oder month angeben — die API antwortet mit 400. Der listBillingCycles-Modus ist getrennt und ignoriert andere Parameter.
Abrechnungsperioden auflisten
Geeignet für Dropdowns vergangener und aktueller Abonnementfenster (jeder Eintrag ist ein periodStartUnix für periodStartUnix=…). Periodenenden werden abgeleitet (nächster Periodenstart − 1, bzw. Stripe current_period_end für die aktive Periode).
curl --location 'https://www.rembg.com/api/membership-usage?listBillingCycles=1' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Beispielantwort
{
"billingCycles": [
{
"periodStartUnix": 1774268612,
"periodEndUnix": 1776947012,
"appUsage": 120,
"apiUsage": 880
}
]
}Sortierung: neueste Periode zuerst. Eine Periode erscheint, wenn ein Cycle-Nutzungsschlüssel existiert oder es der aktuelle billing_period_start aus Stripe-Webhooks ist.
Das Objekt billingCycle
Vorhanden, wenn expand billing_cycle enthält oder includeBillingCycle gesetzt ist. Für Dashboards: Verlängerungsgrenze, Nutzung im Fenster, verbleibende inkludierte Credits.
| Feld | Beschreibung |
|---|---|
| periodStartUnix | Beginn des Abrechnungsfensters (Unix-Sekunden). Entspricht Stripe current_period_start bei synchronisiertem Konto. |
| periodEndUnix | Ende des aktuellen Fensters (Unix-Sekunden), kurz vor der nächsten Verlängerung — bei Sync Stripe current_period_end. Nicht gleichbedeutend mit Kündigungsdatum. |
| appUsage / apiUsage | Inklusive-Nutzung in diesem Fenster: Web/Editor (App) vs. API-Schlüssel (API). usedIncludedCredits ist die Summe. |
| includedCredits | Ihr inkludiertes Kontingent wie in Redis gespeichert (entspricht dem oberen credits-Feld). |
| prepaidCredits | Prepaid-Guthaben (gekauft); wird nicht pro Abrechnungsperiode zurückgesetzt. |
| usedIncludedCredits | Gesamte inklusive Nutzung im Fenster (App + API). Prepaid-Verbrauch zählt hier nicht. |
| remainingIncludedCredits | max(0, includedCredits − usedIncludedCredits) für diesen Snapshot. |
| stripeBillingSynced | true, wenn Redis billing_period_start/end von Stripe hat — Fenster entspricht dem Abonnement; false: UTC-Kalendermonat als Fallback für diesen Block. |
Bis Stripe-Webhooks die Abrechnungszeiten geschrieben haben, kann stripeBillingSynced false sein und das billingCycle-Fenster folgt dem UTC-Kalendermonat. Nach Sync entsprechen die Limits der Bild-API denselben Cycle-Schlüsseln.
Für „verbrauchte Credits vor nächster Verlängerung“: Aufruf mit expand=billing_cycle, billingCycle.periodEndUnix als Verlängerungsgrenze, billingCycle.usedIncludedCredits (oder appUsage + apiUsage), billingCycle.remainingIncludedCredits. Optional prepaidCredits addieren für gesamtes verfügbares Guthaben.
Beispiele (cURL)
Nutzung für einen bestimmten UTC-Kalendermonat
curl --location 'https://www.rembg.com/api/membership-usage?year=2026&month=3' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Aktuelle Abrechnungsperiode inkl. billingCycle (bei Sync an Verlängerung ausgerichtet)
# 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'
Eine vergangene Abrechnungsperiode über Periodenstart (aus listBillingCycles oder 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'
Beispiel-JSON (mit Abrechnungszyklus)
Die Felder app_usage und api_usage beziehen sich immer auf den angefragten Kalendermonat oder — bei periodStartUnix — auf die Cycle-Zähler. Ohne expand=billing_cycle fehlt 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
}
}Ist stripeBillingSynced true, entspricht billingCycle der Durchsetzung auf der Hintergrundentfernungs-API. Bei false Kalendermonatsfelder nutzen oder auf Webhooks warten, die billing_period_* in Redis setzen.
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