API de Suppression d’Arrière-plan RemBG – Documentation Développeur & Guide d’Intégration






OpenAPI · Bac à sable live

Explorez toute l’API — lancez de vraies requêtes dans le navigateur

Parcourez chaque point d’accès, paramètres et réponses. Testez avec votre clé API — la spécification brute reste disponible sur /api/openapi.

Ouvrir la référence interactive

Installation de 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")
  • Configuration de votre environnement : Assurez-vous d'avoir un fichier .env dans la racine de votre projet contenant votre clé API.

  • Importation des modules nécessaires : Commencez par importer la fonction rembg de @remove-background-ai/rembg.js et le module dotenv pour gérer les variables d'environnement.

  • Configuration des callbacks de progression : La bibliothèque offre des callbacks onDownloadProgress et onUploadProgress pour suivre la progression des opérations de fichier. Dans l'exemple fourni, nous enregistrons ces événements directement dans la console.

Maintenant, regardons de plus près un exemple d'utilisation :


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

N'oubliez pas, la fonction de nettoyage peut être appelée si vous souhaitez supprimer l'image traitée de votre disque après la suppression de l'arrière-plan.

Affichage de la barre de progression

Lors de l'intégration d'un service de suppression d'arrière-plan, il est souvent bénéfique de fournir aux utilisateurs un retour sur la progression de leur demande de téléchargement ou de téléversement. Pour faciliter cela, vous pouvez définir vos propres callbacks onDownloadProgress et onUploadProgress. Ces deux callbacks acceptent AxiosProgressEvent comme paramètre d'événement. Au fur et à mesure de la progression de la demande, ces callbacks sont invoqués plusieurs fois, vous permettant, par exemple, d'afficher une barre de progression et d'ajuster sa longueur en fonction de la progression.


 (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
					

Utilisation & crédits

Renvoie le libellé du forfait, les soldes de crédits inclus et prépayés, et l’utilisation. Interrogez par mois civil UTC (existant), par période de facturation alignée Stripe (suivi jusqu’au renouvellement), ou listez les périodes connues. Authentification par clé API uniquement.

Pour les schémas, exemples et une console d’essai, consultez la même opération dans la référence complète : Ouvrir la doc API

Endpoint
GET https://www.rembg.com/api/membership-usage
Authentification

Envoyez votre clé API : en-tête x-api-key: VOTRE_CLE_API (création et gestion dans votre profil sur rembg.com).

Paramètres de requête
ParamètreTypeDescription
yearnumberAnnée civile (1–9999). Avec month, lit les clés Redis user:{uid}:app_usage:{year}:{month}. Si omis (sans periodStartUnix), année UTC courante par défaut.
monthnumber (1–12)Mois civil 1–12 (convention UTC pour les clés). Si omis : mois UTC courant.
periodStartUnixnumberHorodatage Unix en secondes : début d’une fenêtre de facturation. Lit user:{uid}:app_usage:cycle:{periodStartUnix} et api_usage:cycle:…. Incompatible avec year ou month.
expandstringListe séparée par des virgules. Inclure billing_cycle ajoute l’objet billingCycle : période Stripe actuelle si billing_period_* existe dans Redis, sinon mois civil UTC courant. Fonctionne aussi avec periodStartUnix pour une fenêtre précise.
includeBillingCycle1 / trueÉquivalent à expand contenant billing_cycle : valeur 1 ou true pour inclure l’objet billingCycle.
listBillingCycles1 / trueMode dédié : listBillingCycles=1 ou true renvoie uniquement { billingCycles: [...] }. Parcourt Redis pour les clés cycle de l’utilisateur ; les autres paramètres sont ignorés pour cette requête.

Ne pas envoyer periodStartUnix avec year ou month — l’API répond 400. Le mode listBillingCycles est séparé et ignore les autres paramètres.

Lister les périodes de facturation

Utile pour remplir un menu des fenêtres d’abonnement passées et actuelles (chaque entrée est un periodStartUnix à repasser en periodStartUnix=…). Les fins de période sont déduites (début de période suivante − 1, ou Stripe current_period_end pour la période active).

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

Exemple de réponse

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

Tri : période la plus récente en premier. Une période apparaît s’il existe une clé d’usage cycle ou s’il s’agit du billing_period_start courant des webhooks Stripe.

L’objet billingCycle

Présent si expand inclut billing_cycle ou si includeBillingCycle est défini. Pour les tableaux de bord : limite de renouvellement, utilisation dans la fenêtre, crédits inclus restants.

ChampDescription
periodStartUnixDébut de la fenêtre (secondes Unix). Correspond à Stripe current_period_start lorsque le compte est synchronisé.
periodEndUnixFin de la fenêtre courante (secondes Unix), juste avant le prochain renouvellement — Stripe current_period_end si synchronisé. Ce n’est pas la date d’annulation d’abonnement.
appUsage / apiUsageUtilisation des crédits inclus dans cette fenêtre : application web (app) vs clé API (api). usedIncludedCredits est leur somme.
includedCreditsVotre quota inclus tel qu’enregistré dans Redis (équivalent au champ credits racine).
prepaidCreditsSolde prépayé (acheté) ; ne se réinitialise pas à chaque période.
usedIncludedCreditsUtilisation incluse totale dans la fenêtre (app + API). La consommation prépayée n’est pas comptée ici.
remainingIncludedCreditsmax(0, includedCredits − usedIncludedCredits) pour cet instantané.
stripeBillingSyncedtrue si Redis contient billing_period_start/end depuis Stripe — la fenêtre suit l’abonnement ; false : repli sur le mois civil UTC pour ce bloc.

Tant que les webhooks Stripe n’ont pas écrit les périodes, stripeBillingSynced peut être false et la fenêtre billingCycle suit le mois civil UTC. Après synchronisation, les limites de l’API image utilisent les mêmes clés cycle.

Pour les « crédits utilisés avant le prochain renouvellement » : appelez avec expand=billing_cycle et utilisez billingCycle.periodEndUnix comme limite, billingCycle.usedIncludedCredits (ou appUsage + apiUsage), billingCycle.remainingIncludedCredits. Ajoutez prepaidCredits pour le solde total utilisable si besoin.

Exemples (cURL)

Utilisation pour un mois civil UTC donné

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

Période de facturation courante + objet billingCycle complet (aligné sur le renouvellement si synchronisé)

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

Une période passée via le début de période (depuis listBillingCycles ou 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'
Exemple JSON (avec cycle de facturation)

Les champs app_usage et api_usage correspondent toujours au mois demandé ou, avec periodStartUnix, aux compteurs cycle. Sans expand=billing_cycle, billingCycle est absent.

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

Si stripeBillingSynced est true, billingCycle correspond à l’application des quotas sur l’API de suppression d’arrière-plan. Si false, utilisez les champs calendaires ou attendez les webhooks qui remplissent billing_period_* dans 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