RemBG Background Removal API – Developer Docs & Integration Guide






OpenAPI · Živé hřiště

Prozkoumejte plné rozhraní API – spouštějte skutečné požadavky ve svém prohlížeči

Procházet každý koncový bod, parametry a odpovědi. Vyzkoušejte požadavky pomocí klíče API a poté si kdykoli vezměte nezpracovanou specifikaci na /api/openapi.

Spustit interaktivní referenci

Instalace 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")
  • Nastavení prostředí: Ujistěte se, že máte v kořenovém adresáři projektu soubor .env obsahující váš klíč API.

  • Import nezbytných modulů: Začněte importem funkce rembg z @remove-background-ai/rembg.js a modulu dotenv pro zpracování proměnných prostředí.

  • Konfigurace zpětných volání o průběhu: Knihovna nabízí zpětná volání onDownloadProgress a onUploadProgress ke sledování průběhu operací se soubory. V uvedeném příkladu zaznamenáváme tyto události přímo do konzoly.

Nyní se podívejme blíže na ukázkové použití:


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

Pamatujte, že funkci čištění lze vyvolat, pokud chcete po odstranění pozadí odstranit zpracovaný obraz z disku.

Zobrazuje se ukazatel průběhu

Při integraci služby odstraňování na pozadí je často užitečné poskytnout uživatelům zpětnou vazbu o průběhu jejich požadavku na nahrávání nebo stahování. Chcete-li to usnadnit, můžete definovat vlastní zpětná volání onDownloadProgress a onUploadProgress. Obě tato zpětná volání přijímají AxiosProgressEvent jako parametr události. Jak požadavek pokračuje, tato zpětná volání jsou vyvolána vícekrát, což vám umožňuje například zobrazit ukazatel průběhu a upravit jeho délku na základě průběhu.


 (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
					

Využití členství a kreditů

Vrátí štítek vašeho plánu, zahrnuté a předplacené zůstatky kreditu a využití. Můžete se dotazovat podle kalendářního měsíce UTC (starší), podle fakturačního období zarovnaného s pruhy (pro monitorování prostřednictvím obnovení) nebo vypsat známá fakturační období. Proveďte ověření pouze pomocí klíče API.

Schémata, příklady a zkušební konzole naleznete na stejném koncovém bodu v úplné referenci: Otevřené dokumenty API

Koncový bod
GET https://www.rembg.com/api/membership-usage
Ověření

Pošlete svůj klíč API: hlavička x-api-key: YOUR_API_KEY_HERE (vytvořte a spravujte klíče ve svém profilu na rembg.com).

Parametry dotazu
ParametrTypPopis
yearnumberKalendářní rok (1–9999). S měsícem čte Redis keys user:{uid}:app_usage:{year}:{month}. Pokud je vynechán (a periodStartUnix není použit), výchozí hodnota je aktuální rok UTC.
monthnumber (1–12)Kalendářní měsíc 1–12 (konvence UTC používaná pro klíče). Pokud je vynecháno, výchozí je aktuální měsíc UTC.
periodStartUnixnumberUnixové časové razítko v sekundách: začátek fakturačního okna. Čte user:{uid}:app_usage:cycle:{periodStartUnix} a api_usage:cycle:…. Nelze kombinovat s rokem nebo měsícem.
expandstringPříznaky oddělené čárkami. Zahrnutím billing_cycle přidáte objekt billingCycle: aktuální období Stripe, pokud v Redis existuje billing_period_*, jinak aktuální kalendářní měsíc UTC. Funguje také s periodStartUnix pro konkrétní okno.
includeBillingCycle1 / trueStejné jako rozbalení obsahující billing_cycle: nastavte na 1 nebo true pro zahrnutí objektu billingCycle.
listBillingCycles1 / trueVyhrazený režim: listBillingCycles=1 nebo true vrátí pouze { billingCycles: [...] }. Prohledá Redis klíče cyklu pro tohoto uživatele; ostatní parametry dotazu jsou u tohoto požadavku ignorovány.

Nepředávejte periodStartUnix společně s rokem nebo měsícem – API vrátí 400. Režim listBillingCycles je samostatný a ignoruje ostatní parametry.

Vypsat fakturační období

Použijte toto k vyplnění rozevíracího seznamu minulých a aktuálních oken předplatného (každá položka je periodStartUnix, kterou můžete vrátit pomocí periodStartUnix=…). Časy konce období jsou odvozeny (začátek příštího období − 1, nebo Stripe current_period_end pro aktivní období).

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

Příklad odpovědi

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

Nejnovější období seřazeno jako první. Období se zobrazí, pokud existuje klíč pro použití cyklu nebo pokud je to aktuální billing_period_start z webhooků Stripe.

Objekt billingCycle

Přítomno, když je nastaveno rozbalení zahrnuje billing_cycle nebo includeBillingCycle. Použijte jej pro řídicí panely: hranice obnovení, použití v okně a zbývající zahrnuté kredity.

polePopis
periodStartUnixZačátek fakturačního okna (unix sekund). Odpovídá Stripe current_period_start, když je účet synchronizován.
periodEndUnixKonec aktuálního okna (unix sekund), tj. těsně před dalším obnovením — Stripe current_period_end při synchronizaci. Není to stejné jako datum zrušení předplatného.
appUsage / apiUsageVyužití zahrnutého kreditu započítáno v tomto okně: web/editor (aplikace) vs klíč API (api). usedIncludedCredits se rovná jejich součtu.
includedCreditsVáš zahrnutý kredit (plánu) uložený v Redis (stejný nápad jako kredity nejvyšší úrovně).
prepaidCreditsPředplacený (zakoupený) zůstatek; neresetuje každé zúčtovací období.
usedIncludedCreditsCelkové využití zahrnuté v okně (aplikace + API). Předplacená spotřeba se zde nepřipočítává.
remainingIncludedCreditsmax(0, zahrnuté kredity − usedIncludedCredits) pro tento snímek.
stripeBillingSyncedtrue, když má Redis billing_period_start/end od Stripe, takže okno odpovídá vašemu předplatnému; false znamená, že se rozhraní API pro tento blok vrátilo zpět na kalendářní měsíc UTC.

Dokud webhooky Stripe nenapíšou pro uživatele fakturační období, může být stripeBillingSynced nepravdivé a okno billingCycle bude následovat kalendářní měsíc UTC. Po synchronizaci se limity použití na rozhraní API pro obrázky sladí se stejnými klíči cyklu.

Pro „kredity použité před dalším obnovením“ volejte s expand=billing_cycle a jako hranici obnovení použijte billingCycle.periodEndUnix, billingCycle.usedIncludedCredits (nebo appUsage + apiUsage) a billingCycle.remainingIncludedCredits. Pokud chcete celkový disponibilní zůstatek, přidejte předplacené kredity.

Příklady (cURL)

Použití pro konkrétní kalendářní měsíc UTC

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

Aktuální fakturační cyklus + úplný blok billingCycle (při synchronizaci zarovnáno s obnovením)

# 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 podle začátku období (ze seznamuBillingCycles nebo 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'
Příklad JSON (s fakturačním cyklem)

Nejvyšší úroveň app_usage a api_usage vždy odrážejí buď požadovaný kalendářní měsíc, nebo, když je nastaven periodStartUnix, počítadla daného cyklu. Když je expand=billing_cycle vynechán, billingCycle chybí.

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

Když má stripeBillingSynced hodnotu true, billingCycle odpovídá vynucení v rozhraní API pro odstranění na pozadí. Pokud je hodnota false, spoléhejte se na pole kalendářního měsíce nebo počkejte, dokud webhooky nezaplní billing_period_* v 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