Interfejs API do usuwania tła RemBG – dokumentacja dla programistów i przewodnik integracji
Poznaj pełne API – uruchamiaj prawdziwe żądania w swojej przeglądarce
Przeglądaj każdy punkt końcowy, parametry i odpowiedzi. Wypróbuj żądania za pomocą klucza API, a następnie w dowolnym momencie pobierz surową specyfikację z /api/openapi.
Uruchom interaktywne odniesienieInstalacja 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") |
Konfigurowanie środowiska: Upewnij się, że w katalogu głównym projektu masz plik .env zawierający klucz API.
Import niezbędnych modułów: Zacznij od zaimportowania funkcji rembg z @remove-background-ai/rembg.js i modułu dotenv do obsługi zmiennych środowiskowych.
Konfigurowanie wywołań zwrotnych postępu: Biblioteka oferuje wywołania zwrotne onDownloadProgress i onUploadProgress umożliwiające śledzenie postępu operacji na plikach. W podanym przykładzie logujemy te zdarzenia bezpośrednio do konsoli.
Teraz przyjrzyjmy się bliżej przykładowemu użyciu:
// 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();
});
Pamiętaj, że funkcję czyszczenia można wywołać, jeśli chcesz usunąć przetworzony obraz z dysku po usunięciu tła.
Wyświetlanie paska postępu
Podczas integracji usługi usuwania tła często korzystne jest zapewnienie użytkownikom informacji zwrotnych na temat postępu ich żądań przesyłania lub pobierania. Aby to ułatwić, możesz zdefiniować własne wywołania zwrotne onDownloadProgress i onUploadProgress. Obydwa wywołania zwrotne akceptują AxiosProgressEvent jako parametr zdarzenia. W miarę realizacji żądania te wywołania zwrotne są wywoływane wielokrotnie, co pozwala na przykład wyświetlić pasek postępu i dostosować jego długość w zależności od postępu.
(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)
Członkostwo i wykorzystanie kredytów
Zwraca etykietę planu, saldo kredytów uwzględnione i przedpłacone oraz wykorzystanie. Możesz wysyłać zapytania według miesiąca kalendarzowego UTC (starsza wersja), okresu rozliczeniowego dostosowanego do Stripe (w celu monitorowania poprzez odnowienie) lub listy znanych okresów rozliczeniowych. Uwierzytelniaj się wyłącznie za pomocą klucza API.
Schematy, przykłady i konsola próbna znajdują się w pełnym dokumencie dotyczącym tego samego punktu końcowego: Otwórz dokumentację API
Punkt końcowy
GET https://www.rembg.com/api/membership-usageUwierzytelnianie
Wyślij swój klucz API: nagłówek x-api-key: YOUR_API_KEY_HERE (twórz i zarządzaj kluczami w swoim profilu na rembg.com).
Parametry zapytania
| Parametr | Wpisz | Opis |
|---|---|---|
| year | number | Rok kalendarzowy (1–9999). Wraz z miesiącem odczytuje klucze Redis user:{uid}:app_usage:{year}:{month}. Jeśli pominięto (i nie użyto parametru periodStartUnix), domyślnym ustawieniem jest bieżący rok UTC. |
| month | number (1–12) | Miesiące kalendarzowe 1–12 (konwencja UTC używana dla kluczy). Jeśli zostanie pominięty, domyślnym ustawieniem będzie bieżący miesiąc UTC. |
| periodStartUnix | number | Znacznik czasu Uniksa w sekundach: początek okna rozliczeniowego. Odczytuje użytkownika:{uid}:app_usage:cycle:{periodStartUnix} i api_usage:cycle:…. Nie można łączyć z rokiem ani miesiącem. |
| expand | string | Flagi rozdzielane przecinkami. Dołącz billing_cycle, aby dodać obiekt billingCycle: bieżący okres Stripe, gdy billing_period_* istnieje w Redis, w przeciwnym razie bieżący miesiąc kalendarzowy UTC. Działa również z periodStartUnix dla określonego okna. |
| includeBillingCycle | 1 / true | To samo co rozwinięcie zawierające cykl_bilingowy: ustaw na 1 lub true, aby uwzględnić obiekt billingCycle. |
| listBillingCycles | 1 / true | Tryb dedykowany: listBillingCycles=1 lub true zwraca tylko { billingCycles: [...] }. Skanuje Redis w poszukiwaniu kluczy cykli dla tego użytkownika; inne parametry zapytania są ignorowane w tym żądaniu. |
Nie przekazuj periodStartUnix razem z rokiem lub miesiącem — API zwraca 400. Tryb listBillingCycles jest oddzielny i ignoruje inne parametry.
Lista okresów rozliczeniowych
Użyj tego, aby wypełnić listę przeszłych i bieżących okien subskrypcji (każdy wpis to periodStartUnix, który możesz przekazać za pomocą periodStartUnix=…). Wyliczane są czasy zakończenia okresu (początek następnego okresu - 1 lub koniec bieżącego_okresu dla aktywnego okresu).
curl --location 'https://www.rembg.com/api/membership-usage?listBillingCycles=1' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Przykładowa odpowiedź
{
"billingCycles": [
{
"periodStartUnix": 1774268612,
"periodEndUnix": 1776947012,
"appUsage": 120,
"apiUsage": 880
}
]
}Najpierw posortowano najnowszy okres. Kropka pojawia się, jeśli istnieje klucz wykorzystania cyklu lub jeśli jest to bieżący okres rozliczeniowy_start z webhooków Stripe.
Obiekt billingCycle
Występuje, gdy ustawiono opcję rozwiń obejmuje cykl_bilingowy lub cykl obejmująBillingCycle. Użyj go do pulpitów nawigacyjnych: granica odnowienia, wykorzystanie w oknie i pozostałe uwzględnione kredyty.
| Pole | Opis |
|---|---|
| periodStartUnix | Początek okna rozliczeniowego (sekundy uniksowe). Pasuje do Stripe current_period_start, gdy konto jest zsynchronizowane. |
| periodEndUnix | Koniec bieżącego okna (sekundy uniksowe), tj. tuż przed kolejnym odnowieniem — Pasek current_period_end po synchronizacji. Nie to samo, co data anulowania subskrypcji. |
| appUsage / apiUsage | Uwzględnione wykorzystanie środków liczone w tym oknie: internet/edytor (aplikacja) vs klucz API (api). wykorzystaneIncludedCredits są równe ich sumie. |
| includedCredits | Twój uwzględniony (plan) limit kredytowy przechowywany w Redis (taki sam pomysł, jak kredyty najwyższego poziomu). |
| prepaidCredits | Saldo przedpłacone (zakupione); nie resetuje każdego okresu rozliczeniowego. |
| usedIncludedCredits | Całkowite wykorzystanie w oknie (aplikacja + API). Zużycie przedpłacone nie jest tu doliczane. |
| remainingIncludedCredits | max(0, includeCredits − wykorzystaneIncludedCredits) dla tej migawki. |
| stripeBillingSynced | true, gdy Redis ma billing_period_start/end od Stripe, więc okno pasuje do Twojej subskrypcji; false oznacza, że dla tego bloku interfejs API powrócił do miesiąca kalendarzowego UTC. |
Dopóki webhooki Stripe nie zapiszą okresów rozliczeniowych dla użytkownika, stripeBillingSynced może mieć wartość false, a okno billingCycle będzie zgodne z miesiącem kalendarzowym UTC. Po synchronizacji limity użytkowania w interfejsie API obrazu odpowiadają tym samym kluczom cykli.
W przypadku „kredytów wykorzystanych przed następnym odnowieniem” wywołaj metodę Expand=billing_cycle i użyj billingCycle.periodEndUnix jako granicy odnowienia, billingCycle.usedIncludedCredits (lub appUsage + apiUsage) i billingCycle.remainingIncludedCredits. Dodaj kredyty przedpłacone, jeśli chcesz mieć całkowite saldo do dyspozycji.
Przykłady (cURL)
Wykorzystanie w określonym miesiącu kalendarzowym UTC
curl --location 'https://www.rembg.com/api/membership-usage?year=2026&month=3' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Bieżący cykl rozliczeniowy + pełna blokada cyklu rozliczeniowego (wyrównane odnowienie po synchronizacji)
# 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 historyczne okno rozliczeniowe według początku okresu (z listyBillingCycles lub 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'
Przykład JSON (z cyklem rozliczeniowym)
App_usage i api_usage najwyższego poziomu zawsze odzwierciedlają żądany miesiąc kalendarzowy lub, jeśli ustawiono periodStartUnix, liczniki tego cyklu. Jeśli pominięto opcję Expand=billing_cycle, BillingCycle jest nieobecny.
{
"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
}
}Gdy stripeBillingSynced ma wartość true, billingCycle dopasowuje egzekwowanie w interfejsie API usuwania tła. Jeśli false, polegaj na polach miesiąca kalendarzowego lub poczekaj, aż webhooki zapełnią billing_period_* w 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