API RemBG per la rimozione dello sfondo – Documenti per gli sviluppatori e guida all'integrazione
Esplora l'API completa: esegui richieste reali nel tuo browser
Sfoglia ogni endpoint, parametro e risposta. Prova le richieste con la tua chiave API, quindi prendi le specifiche grezze su /api/openapi in qualsiasi momento.
Avvia riferimento interattivoInstallazione di 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") |
Configurazione dell'ambiente: Assicurati di avere un file .env nella root del progetto contenente la chiave API.
Importazione dei moduli necessari: Inizia importando la funzione rembg da @remove- background-ai/rembg.js e il modulo dotenv per gestire le variabili di ambiente.
Configurazione delle richiamate di avanzamento: La libreria offre callback onDownloadProgress e onUploadProgress per tenere traccia dell'avanzamento delle operazioni sui file. Nell'esempio fornito, registriamo questi eventi direttamente sulla console.
Ora diamo uno sguardo più da vicino a un esempio di utilizzo:
// 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();
});
Ricorda, la funzione di pulizia può essere richiamata se desideri rimuovere l'immagine elaborata dal disco dopo la rimozione dello sfondo.
Visualizzazione della barra di avanzamento
Quando si integra un servizio di rimozione in background, spesso è utile fornire agli utenti un feedback sullo stato di avanzamento della loro richiesta di caricamento o download. Per facilitare ciò, puoi definire i tuoi callback onDownloadProgress e onUploadProgress. Entrambi questi callback accettano AxiosProgressEvent come parametro di evento. Man mano che la richiesta procede, queste richiamate vengono richiamate più volte, consentendo, ad esempio, di visualizzare una barra di avanzamento e di regolarne la lunghezza in base all'avanzamento.
(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)
Abbonamento e utilizzo dei crediti
Restituisce l'etichetta del piano, i saldi dei crediti inclusi e prepagati e l'utilizzo. Puoi eseguire query in base al mese di calendario UTC (legacy), in base al periodo di fatturazione allineato con Stripe (per il monitoraggio fino al rinnovo) o elencare i periodi di fatturazione noti. Autenticati solo con la tua chiave API.
Per schemi, esempi e una console di prova, vedere lo stesso endpoint nel riferimento completo: Apri documenti API
Punto finale
GET https://www.rembg.com/api/membership-usageAutenticazione
Invia la tua chiave API: header x-api-key: YOUR_API_KEY_HERE (crea e gestisci le chiavi nel tuo profilo su rembg.com).
Parametri della query
| Parametro | Digita | Descrizione |
|---|---|---|
| year | number | Anno solare (1–9999). Con il mese, legge le chiavi Redis user:{uid}:app_usage:{year}:{month}. Se omesso (e periodStartUnix non viene utilizzato), il valore predefinito è l'anno UTC corrente. |
| month | number (1–12) | Mese di calendario 1–12 (convenzione UTC utilizzata per le chiavi). Se omesso, il valore predefinito è il mese UTC corrente. |
| periodStartUnix | number | Timestamp Unix in secondi: inizio di una finestra di fatturazione. Legge user:{uid}:app_usage:cycle:{periodStartUnix} e api_usage:cycle:…. Non può essere combinato con anno o mese. |
| expand | string | Flag separati da virgole. Includi billing_cycle per aggiungere un oggetto billingCycle: periodo Stripe corrente quando billing_period_* esiste in Redis, altrimenti il mese di calendario UTC corrente. Funziona anche con periodStartUnix per una finestra specifica. |
| includeBillingCycle | 1 / true | Uguale all'espansione contenente billing_cycle: impostato su 1 o true per includere l'oggetto billingCycle. |
| listBillingCycles | 1 / true | Modalità dedicata: listBillingCycles=1 o true restituisce solo { billingCycles: [...] }. Esegue la scansione di Redis per le chiavi di ciclo per questo utente; altri parametri di query vengono ignorati in questa richiesta. |
Non passare periodStartUnix insieme all'anno o al mese: l'API restituisce 400. La modalità listBillingCycles è separata e ignora altri parametri.
Elenca periodi di fatturazione
Utilizzalo per popolare un menu a discesa delle finestre di abbonamento passate e attuali (ogni voce è un periodStartUnix che puoi restituire con periodStartUnix=…). Vengono dedotti gli orari di fine del periodo (inizio del periodo successivo - 1 o Stripe current_period_end per il periodo attivo).
curl --location 'https://www.rembg.com/api/membership-usage?listBillingCycles=1' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Esempio di risposta
{
"billingCycles": [
{
"periodStartUnix": 1774268612,
"periodEndUnix": 1776947012,
"appUsage": 120,
"apiUsage": 880
}
]
}Ordinato per primo il periodo più recente. Viene visualizzato un periodo se è presente una chiave di utilizzo del ciclo o se è l'attuale billing_period_start dai webhook Stripe.
L'oggetto billingCycle
Presente quando è impostata l'espansione include billing_cycle o includeBillingCycle. Usalo per i dashboard: limite di rinnovo, utilizzo nella finestra e crediti inclusi rimanenti.
| Campo | Descrizione |
|---|---|
| periodStartUnix | Inizio della finestra di fatturazione (unix secondi). Corrisponde a Stripe current_period_start quando l'account viene sincronizzato. |
| periodEndUnix | Fine della finestra corrente (unix secondi), ovvero appena prima del prossimo rinnovo: stripe current_period_end quando sincronizzato. Non corrisponde alla data di annullamento dell'abbonamento. |
| appUsage / apiUsage | Utilizzo del credito incluso conteggiato in questa finestra: web/editor (app) vs chiave API (api). usedIncludedCredits è uguale alla loro somma. |
| includedCredits | Il tuo limite di credito incluso (nel piano) memorizzato in Redis (stessa idea dei crediti di livello superiore). |
| prepaidCredits | Saldo prepagato (acquistato); non reimposta ogni periodo di fatturazione. |
| usedIncludedCredits | Utilizzo totale incluso nella finestra (app + API). Il consumo prepagato non viene aggiunto qui. |
| remainingIncludedCredits | max(0, includesCredits − usedIncludedCredits) per questo snapshot. |
| stripeBillingSynced | true quando Redis ha billing_period_start/end da Stripe in modo che la finestra corrisponda al tuo abbonamento; false significa che l'API è tornata a un mese di calendario UTC per questo blocco. |
Fino a quando i webhook Stripe non avranno scritto i periodi di fatturazione per l'utente, stripeBillingSynced potrebbe essere falso e la finestra billingCycle segue il mese di calendario UTC. Dopo la sincronizzazione, i limiti di utilizzo sull'API immagine si allineano alle stesse chiavi di ciclo.
Per i "crediti utilizzati prima del prossimo rinnovo", chiama con expand=billing_cycle e utilizza billingCycle.periodEndUnix come limite di rinnovo, billingCycle.usedIncludedCredits (o appUsage + apiUsage) e billingCycle.remainingIncludedCredits. Aggiungi crediti prepagati se desideri un saldo disponibile totale.
Esempi (cURL)
Utilizzo per un mese di calendario UTC specifico
curl --location 'https://www.rembg.com/api/membership-usage?year=2026&month=3' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Ciclo di fatturazione attuale + blocco ciclo di fatturazione completo (allineato al rinnovo quando sincronizzato)
# 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'
Una finestra di fatturazione storica per inizio periodo (da listBillingCycles o 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'
Esempio JSON (con ciclo di fatturazione)
app_usage e api_usage di livello superiore riflettono sempre il mese di calendario richiesto o, quando è impostato periodStartUnix, i contatori di quel ciclo. Quando expand=billing_cycle viene omesso, billingCycle è assente.
{
"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
}
}Quando stripeBillingSynced è true, billingCycle corrisponde all'applicazione sull'API di rimozione in background. Se falso, fai affidamento sui campi del mese di calendario o attendi finché i webhook non compilano billing_period_* in 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