RemBG Background Removal API – Developer Docs & Integration Guide
Tutustu koko sovellusliittymään – suorita todellisia pyyntöjä selaimessasi
Selaa kaikkia päätepisteitä, parametreja ja vastauksia. Kokeile pyyntöjä API-avaimellasi ja hanki raaka-asetukset osoitteesta /api/openapi milloin tahansa.
Käynnistä interaktiivinen viiteRembg.js:n asennus
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") |
Ympäristön määrittäminen: Varmista, että projektin juuressa on .env-tiedosto, joka sisältää API-avaimesi.
Tarvittavien moduulien tuonti: Aloita tuomalla rembg-funktio tiedostosta @remove-background-ai/rembg.js ja dotenv-moduuli käsittelemään ympäristömuuttujia.
Edistymisen takaisinkutsujen määrittäminen: Kirjasto tarjoaa onDownloadProgress- ja onUploadProgress-puhelut tiedostotoimintojen edistymisen seuraamiseksi. Esitetyssä esimerkissä kirjaamme nämä tapahtumat suoraan konsoliin.
Tarkastellaan nyt lähemmin esimerkkiä käytöstä:
// 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();
});
Muista, että puhdistustoiminto voidaan kutsua, jos haluat poistaa käsitellyn kuvan levyltäsi taustan poistamisen jälkeen.
Näytetään edistymispalkki
Taustapoistopalvelua integroitaessa on usein hyödyllistä antaa käyttäjille palautetta lataus- tai latauspyynnön edistymisestä. Tämän helpottamiseksi voit määrittää omat onDownloadProgress- ja onUploadProgress-puhelut. Molemmat takaisinkutsut hyväksyvät AxiosProgressEventin tapahtumaparametriksi. Pyynnön edetessä näitä takaisinsoittoja kutsutaan useita kertoja, jolloin voit esimerkiksi näyttää edistymispalkin ja säätää sen pituutta edistymisen perusteella.
(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)
Jäsenyyden ja hyvitysten käyttö
Palauttaa suunnitelmasi etiketin, mukana tulleet ja ennakkoon maksetut saldot sekä käytön. Voit tehdä kyselyn UTC-kalenterikuukauden (vanha), Stripe-tasoitettujen laskutuskausien mukaan (seurantaa varten uusimisen kautta) tai luetella tunnetut laskutuskaudet. Todenna vain API-avaimellasi.
Katso mallit, esimerkit ja try-it-konsoli samasta päätepisteestä täydellisessä viitteessä: Avaa API-dokumentit
Päätepiste
GET https://www.rembg.com/api/membership-usageTodennus
Lähetä API-avaimesi: header x-api-key: YOUR_API_KEY_HERE (luo ja hallitse avaimia profiilissasi osoitteessa rembg.com).
Kyselyparametrit
| Parametri | Kirjoita | Kuvaus |
|---|---|---|
| year | number | Kalenterivuosi (1–9999). Kuukauden kohdalla lukee Redis Keys user:{uid}:app_usage:{year}:{month}. Jos jätetään pois (ja periodStartUnix ei ole käytössä), oletusarvo on nykyinen UTC-vuosi. |
| month | number (1–12) | Kalenterikuukausi 1–12 (avainten UTC-käytäntö). Jos jätetään pois, oletusarvo on nykyinen UTC-kuukausi. |
| periodStartUnix | number | Unix-aikaleima sekunneissa: laskutusikkunan alku. Lukee user:{uid}:app_usage:cycle:{periodStartUnix} ja api_usage:cycle:…. Ei voida yhdistää vuoteen tai kuukauteen. |
| expand | string | Pilkuilla erotetut liput. Sisällytä billing_cycle lisätäksesi billingCycle-objektin: nykyinen Stripe-jakso, kun laskutuskausi_* on olemassa Redisissä, muuten nykyinen UTC-kalenterikuukausi. Toimii myös periodStartUnixin kanssa tietyssä ikkunassa. |
| includeBillingCycle | 1 / true | Sama kuin laajennus, joka sisältää laskutussyklin: aseta arvoksi 1 tai tosi, jos haluat sisällyttää billingCycle-objektin. |
| listBillingCycles | 1 / true | Dedikoitu tila: listBillingCycles=1 tai true palauttaa vain { billingCycles: [...] }. Etsii Redistä tämän käyttäjän syklinäppäimiä varten; muut kyselyparametrit ohitetaan tässä pyynnössä. |
Älä ohita periodStartUnix-arvoa yhdessä vuoden tai kuukauden kanssa – API palauttaa 400. ListBillingCycles-tila on erillinen ja jättää muut parametrit huomioimatta.
Luettelo laskutuskaudet
Käytä tätä täyttääksesi aiempien ja nykyisten tilausikkunoiden pudotusvalikon (jokainen merkintä on periodStartUnix, jonka voit palauttaa komennolla periodStartUnix=…). Jakson päättymisajat päätellään (seuraavan jakson alku − 1 tai Stripe nykyinen_jakso_loppu aktiiviselle jaksolle).
curl --location 'https://www.rembg.com/api/membership-usage?listBillingCycles=1' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Esimerkkivastaus
{
"billingCycles": [
{
"periodStartUnix": 1774268612,
"periodEndUnix": 1776947012,
"appUsage": 120,
"apiUsage": 880
}
]
}Lajiteltu uusin jakso ensin. Piste tulee näkyviin, jos käytettävissä on syklin käyttöavain tai jos se on Stripe-webhooksin nykyinen laskutusjakson_aloitus.
BillingCycle -objekti
Esitetään, kun laajennus sisältää laskutussyklin tai includeBillingCycle on asetettu. Käytä sitä kojelaudoissa: uusimisraja, käyttö ikkunassa ja jäljellä olevat krediitit.
| Kenttä | Kuvaus |
|---|---|
| periodStartUnix | Laskutusikkunan alku (unix sekuntia). Vastaa Stripe current_period_start -arvoa, kun tili on synkronoitu. |
| periodEndUnix | Nykyisen ikkunan loppu (unix sekuntia), eli juuri ennen seuraavaa uusimista — Raita current_period_end synkronoituna. Ei sama kuin tilauksen peruutuspäivä. |
| appUsage / apiUsage | Tässä ikkunassa laskettu mukana olevan hyvityksen käyttö: verkko/editori (sovellus) vs. API-avain (api). UsedIncludedCredits on yhtä suuri kuin niiden summa. |
| includedCredits | Mukana (suunnitelman) luottokorvaus Redikseen tallennettuna (sama idea kuin huipputason luottoja). |
| prepaidCredits | Ennakkoon maksettu (ostettu) saldo; ei nollaa jokaista laskutuskautta. |
| usedIncludedCredits | Ikkunan sisältämä käyttö yhteensä (sovellus + API). Prepaid-kulutusta ei lisätä tähän. |
| remainingIncludedCredits | max(0, Sisältää krediittejä − käytettySisältää krediittejä) tälle tilannekuvalle. |
| stripeBillingSynced | tosi, kun Rediksen laskutuskauden_aloitus/loppu on Stripestä, joten ikkuna vastaa tilaustasi; false tarkoittaa, että API palasi UTC-kalenterikuukauteen tälle lohkolle. |
Ennen kuin Stripe-webhookit ovat kirjoittaneet laskutuskaudet käyttäjälle, stripeBillingSynced voi olla väärä ja laskutussykli-ikkuna seuraa UTC-kalenterikuukautta. Synkronoinnin jälkeen kuva-API:n käyttörajoitukset ovat samat samojen syklinäppäinten kanssa.
Ennen seuraavaa uusimista käytetyille hyvityksille soita komennolla expand=billing_cycle ja käytä billingCycle.periodEndUnix uusimisrajana, billingCycle.usedIncludedCredits (tai appUsage + apiUsage) ja billingCycle.remainingIncludedCredits. Lisää prepaidCredits, jos haluat kokonaissaldon.
Esimerkkejä (cURL)
Tietyn UTC-kalenterikuukauden käyttö
curl --location 'https://www.rembg.com/api/membership-usage?year=2026&month=3' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Nykyinen laskutusjakso + täysi laskutusjakson esto (uusituskohdistettu synkronoinnin yhteydessä)
# 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'
Yksi historiallinen laskutusikkuna jakson alun mukaan (listaBillingCycles tai 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'
Esimerkki JSON (laskutusjaksolla)
Ylätason app_usage ja api_usage heijastavat aina joko pyydettyä kalenterikuukautta tai, kun periodStartUnix on asetettu, kyseisen jakson laskureita. Kun expand=billing_cycle jätetään pois, laskutussykli puuttuu.
{
"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
}
}Kun stripeBillingSynced on tosi, billingCycle vastaa taustan poiston sovellusliittymän pakottamista. Jos se on epätosi, luota kalenterikuukauden kenttiin tai odota, kunnes webhookit täyttävät laskutusjakson_* Redisissä.
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