Interfejs API do usuwania tła RemBG – dokumentacja dla programistów i przewodnik integracji






OpenAPI · Plac zabaw na żywo

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 odniesienie

Instalacja rembg.js

latest npm versionGitHub starsnpm downloadslicenseGitHub issues

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
ParameterTypeRequiredDefaultDescription
apiKeystring
Required

Your Rembg API key
inputImagestring | 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.formatwebp (default) | png
Optional
webp
Specifies the output image format. Either "webp" (default) or "png"
options.returnBase64boolean
Optional
false
Return Base64 string instead of file
options.returnMaskboolean
Optional
false
Return only the alpha mask
options.wnumber
Optional

Target width (maintains aspect ratio)
options.hnumber
Optional

Target height (maintains aspect ratio)
options.exact_resizeboolean
Optional
false
Force exact width × height (may distort)
options.anglenumber
Optional
0
Rotation angle in degrees
options.expandboolean
Optional
true
Add padding so rotated images aren’t cropped
options.bg_colorstring
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
					

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-usage
Uwierzytelnianie

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
ParametrWpiszOpis
yearnumberRok 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.
monthnumber (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.
periodStartUnixnumberZnacznik 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.
expandstringFlagi 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.
includeBillingCycle1 / trueTo samo co rozwinięcie zawierające cykl_bilingowy: ustaw na 1 lub true, aby uwzględnić obiekt billingCycle.
listBillingCycles1 / trueTryb 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.

PoleOpis
periodStartUnixPoczątek okna rozliczeniowego (sekundy uniksowe). Pasuje do Stripe current_period_start, gdy konto jest zsynchronizowane.
periodEndUnixKoniec bieżącego okna (sekundy uniksowe), tj. tuż przed kolejnym odnowieniem — Pasek current_period_end po synchronizacji. Nie to samo, co data anulowania subskrypcji.
appUsage / apiUsageUwzględnione wykorzystanie środków liczone w tym oknie: internet/edytor (aplikacja) vs klucz API (api). wykorzystaneIncludedCredits są równe ich sumie.
includedCreditsTwój uwzględniony (plan) limit kredytowy przechowywany w Redis (taki sam pomysł, jak kredyty najwyższego poziomu).
prepaidCreditsSaldo przedpłacone (zakupione); nie resetuje każdego okresu rozliczeniowego.
usedIncludedCreditsCałkowite wykorzystanie w oknie (aplikacja + API). Zużycie przedpłacone nie jest tu doliczane.
remainingIncludedCreditsmax(0, includeCredits − wykorzystaneIncludedCredits) dla tej migawki.
stripeBillingSyncedtrue, 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.

Single Error Response

HTTP/1.1 400 Bad Request

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "error": "Image width (12000px) exceeds the maximum allowed width of 10000px.",
  "field": "image",
  "status": 400
}

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
ScenarioStatusError 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 error field for the error message
  • Check for the details array when handling multiple validation errors
  • Use the field property to map errors to specific request parameters