RemBG Background Removal API – Developer Docs & Integration Guide






OpenAPI · Live legeplads

Udforsk den fulde API - kør rigtige anmodninger i din browser

Gennemse alle slutpunkter, parametre og svar. Prøv anmodninger med din API-nøgle, og tag derefter den rå spec på /api/openapi når som helst.

Start interaktiv reference

Installation af 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")
  • Opsætning af dit miljø: Sørg for, at du har en .env-fil i dit projektrod, der indeholder din API-nøgle.

  • Import af de nødvendige moduler: Begynd med at importere rembg-funktionen fra @remove-background-ai/rembg.js og dotenv-modulet for at håndtere miljøvariabler.

  • Konfiguration af statustilbagekald: Biblioteket tilbyder onDownloadProgress og onUploadProgress-tilbagekald for at spore forløbet af filhandlinger. I det angivne eksempel logger vi disse hændelser direkte til konsollen.

Lad os nu se nærmere på et eksempel på brugen:


// 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();
});
					
						

Husk, at oprydningsfunktionen kan kaldes, hvis du ønsker at fjerne det behandlede billede fra din disk efter fjernelse af baggrunden.

Viser statuslinje

Når du integrerer en tjeneste til fjernelse af baggrunden, er det ofte en fordel at give brugerne feedback om status for deres upload- eller downloadanmodning. For at lette dette kan du definere dine egne onDownloadProgress og onUploadProgress tilbagekald. Begge disse tilbagekald accepterer AxiosProgressEvent som en hændelsesparameter. Efterhånden som anmodningen skrider frem, kaldes disse tilbagekald flere gange, hvilket giver dig mulighed for for eksempel at vise en statuslinje og justere dens længde baseret på fremskridtene.


 (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
					

Brug af medlemskab og kreditter

Returnerer din planlabel, inkluderet og forudbetalt kreditsaldo og brug. Du kan forespørge efter UTC-kalendermåned (legacy), efter Stripe-aligned faktureringsperiode (til overvågning gennem fornyelse) eller angive kendte faktureringsperioder. Autentificer kun med din API-nøgle.

For skemaer, eksempler og en prøv-det-konsol, se det samme slutpunkt i den fulde reference: Åbn API-dokumenter

Slutpunkt
GET https://www.rembg.com/api/membership-usage
Godkendelse

Send din API-nøgle: header x-api-key: YOUR_API_KEY_HERE (opret og administrer nøgler i din profil på rembg.com).

Forespørgselsparametre
ParameterIndtastBeskrivelse
yearnumberKalenderår (1-9999). Med måned, står Redis nøgler bruger:{uid}:app_usage:{year}:{month}. Hvis udeladt (og periodStartUnix ikke bruges), er standard til det aktuelle UTC-år.
monthnumber (1–12)Kalendermåned 1-12 (UTC-konvention bruges til nøgler). Hvis udeladt, indstilles som standard til den aktuelle UTC-måned.
periodStartUnixnumberUnix-tidsstempel i sekunder: start af et faktureringsvindue. Læser bruger:{uid}:app_usage:cycle:{periodStartUnix} og api_usage:cycle:…. Kan ikke kombineres med år eller måned.
expandstringKommaseparerede flag. Inkluder billing_cycle for at tilføje et billingCycle-objekt: nuværende Stripe-periode, når billing_period_* findes i Redis, ellers den aktuelle UTC-kalendermåned. Fungerer også med periodStartUnix for et bestemt vindue.
includeBillingCycle1 / trueSamme som expand, der indeholder billing_cycle: indstillet til 1 eller sand for at inkludere billingCycle-objektet.
listBillingCycles1 / trueDedikeret tilstand: listBillingCycles=1 eller sand returnerer kun { billingCycles: [...] }. Scanner Redis for cyklusnøgler for denne bruger; other query parameters are ignored on this request.

Bestå ikke periodStartUnix sammen med år eller måned — API'en returnerer 400. ListBillingCycles-tilstanden er separat og ignorerer andre parametre.

Vis faktureringsperioder

Brug dette til at udfylde en rullemenu med tidligere og nuværende abonnementsvinduer (hver post er en periodStartUnix, som du kan sende tilbage med periodStartUnix=...). Periodens sluttidspunkt udledes (start af næste periode − 1, eller Stripe current_period_end for den aktive periode).

curl --location 'https://www.rembg.com/api/membership-usage?listBillingCycles=1' \
  --header 'x-api-key: YOUR_API_KEY_HERE'

Eksempel svar

{
  "billingCycles": [
    {
      "periodStartUnix": 1774268612,
      "periodEndUnix": 1776947012,
      "appUsage": 120,
      "apiUsage": 880
    }
  ]
}

Sorteret nyeste periode først. En periode vises, hvis der er en cyklusbrugsnøgle, eller hvis det er den aktuelle billing_period_start fra Stripe webhooks.

billingCycle-objektet

Til stede, når expand include billing_cycle eller includeBillingCycle er indstillet. Brug det til dashboards: fornyelsesgrænse, brug i vinduet og resterende inkluderede kreditter.

FeltBeskrivelse
periodStartUnixStart af faktureringsvinduet (unix sekunder). Matcher Stripe current_period_start, når kontoen er synkroniseret.
periodEndUnixSlut på det aktuelle vindue (unix sekunder), dvs. lige før næste fornyelse — Stripe current_period_end ved synkronisering. Ikke det samme som dato for opsigelse af abonnement.
appUsage / apiUsageBrug af inkluderet kredit tælles i dette vindue: web/editor (app) vs API-nøgle (api). usedIncludedCredits er lig med deres sum.
includedCreditsDin inkluderede (plan) kreditgodtgørelse som gemt i Redis (samme idé som kreditter på øverste niveau).
prepaidCreditsForudbetalt (købt) saldo; nulstiller ikke hver faktureringsperiode.
usedIncludedCreditsSamlet inkluderet brug i vinduet (app + API). Forudbetalt forbrug tilføjes ikke her.
remainingIncludedCreditsmax(0, inkluderede kreditter − brugte inkluderede kreditter) for dette øjebliksbillede.
stripeBillingSyncedsandt, når Redis har billing_period_start/end fra Stripe, så vinduet matcher dit abonnement; falsk betyder, at API'et faldt tilbage til en UTC-kalendermåned for denne blok.

Indtil Stripe webhooks har skrevet faktureringsperioder for brugeren, kan stripeBillingSynced være falsk, og billingCycle-vinduet følger UTC-kalendermåneden. Efter synkronisering justeres brugsgrænserne på billed-API'en med de samme cyklusnøgler.

For "kreditter brugt før næste fornyelse", ring med expand=billing_cycle og brug billingCycle.periodEndUnix som fornyelsesgrænsen, billingCycle.usedIncludedCredits (eller appUsage + apiUsage) og billingCycle.remainingIncludedCredits. Tilføj forudbetalte kreditter, hvis du ønsker en samlet disponibel saldo.

Eksempler (cURL)

Brug for en bestemt UTC-kalendermåned

curl --location 'https://www.rembg.com/api/membership-usage?year=2026&month=3' \
  --header 'x-api-key: YOUR_API_KEY_HERE'

Aktuel faktureringscyklus + fuld faktureringscyklusblok (fornyelsesjusteret ved synkronisering)

# 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'

Ét historisk faktureringsvindue efter periodestart (fra listBillingCycles eller 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'
Eksempel JSON (med faktureringscyklus)

App_usage og api_usage på topniveau afspejler altid enten den anmodede kalendermåned eller, når periodStartUnix er indstillet, den cyklus tællere. Når expand=billing_cycle er udeladt, er billingCycle fraværende.

{
  "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
  }
}

Når stripeBillingSynced er sandt, matcher billingCycle håndhævelsen af baggrundsfjernelses-API'en. Når falsk, skal du stole på kalendermånedsfelter eller vente, indtil webhooks udfylder billing_period_* i 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