API de remoção de plano de fundo RemBG – Documentação do desenvolvedor e guia de integração






OpenAPI · Playground ao vivo

Explore a API completa: execute solicitações reais em seu navegador

Procure todos os endpoints, parâmetros e respostas. Experimente solicitações com sua chave de API e obtenha as especificações brutas em /api/openapi a qualquer momento.

Iniciar referência interativa

Instalação 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")
  • Configurando seu ambiente: Certifique-se de ter um arquivo .env na raiz do projeto contendo sua chave de API.

  • Importando os módulos necessários: Comece importando a função rembg de @remove-background-ai/rembg.js e o módulo dotenv para lidar com variáveis de ambiente.

  • Configurando retornos de chamada de progresso: A biblioteca oferece retornos de chamada onDownloadProgress e onUploadProgress para rastrear o progresso das operações de arquivo. No exemplo fornecido, estamos registrando esses eventos diretamente no console.

Agora, vamos examinar mais de perto um exemplo de uso:


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

Lembre-se, a função de limpeza pode ser chamada se você desejar remover a imagem processada do seu disco após a remoção do fundo.

Mostrando barra de progresso

Ao integrar um serviço de remoção de plano de fundo, geralmente é benéfico fornecer aos usuários feedback sobre o andamento da solicitação de upload ou download. Para facilitar isso, você pode definir seus próprios retornos de chamada onDownloadProgress e onUploadProgress. Ambos os retornos de chamada aceitam AxiosProgressEvent como parâmetro de evento. À medida que a solicitação avança, esses retornos de chamada são invocados diversas vezes, permitindo, por exemplo, exibir uma barra de progresso e ajustar sua duração com base no progresso.


 (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
					

Uso de assinatura e créditos

Retorna o rótulo do seu plano, saldos de crédito incluídos e pré-pagos e uso. Você pode consultar por mês UTC (legado), por período de faturamento alinhado ao Stripe (para monitoramento por meio de renovação) ou listar períodos de faturamento conhecidos. Autentique apenas com sua chave de API.

Para esquemas, exemplos e um console de teste, consulte o mesmo endpoint na referência completa: Abrir documentos da API

Ponto final
GET https://www.rembg.com/api/membership-usage
Autenticação

Envie sua chave de API: header x-api-key: YOUR_API_KEY_HERE (crie e gerencie chaves em seu perfil em rembg.com).

Parâmetros de consulta
ParâmetroDigiteDescrição
yearnumberAno civil (1–9999). Com mês, lê as chaves Redis user:{uid}:app_usage:{year}:{month}. Se omitido (e periodStartUnix não for usado), o padrão é o ano UTC atual.
monthnumber (1–12)Mês 1 a 12 (convenção UTC usada para chaves). Se omitido, o padrão é o mês UTC atual.
periodStartUnixnumberCarimbo de data/hora Unix em segundos: início de uma janela de faturamento. Lê usuário:{uid}:app_usage:cycle:{periodStartUnix} e api_usage:cycle:…. Não pode ser combinado com ano ou mês.
expandstringSinalizadores separados por vírgula. Inclua billing_cycle para adicionar um objeto billingCycle: período atual do Stripe quando billing_period_* existir no Redis, caso contrário, o mês atual do calendário UTC. Também funciona com periodStartUnix para uma janela específica.
includeBillingCycle1 / trueO mesmo que expandir contendo billing_cycle: defina como 1 ou verdadeiro para incluir o objeto billingCycle.
listBillingCycles1 / trueModo dedicado: listBillingCycles=1 ou true retorna apenas { billingCycles: [...] }. Verifica o Redis em busca de chaves de ciclo para este usuário; outros parâmetros de consulta são ignorados nesta solicitação.

Não passe periodStartUnix junto com ano ou mês — a API retorna 400. O modo listBillingCycles é separado e ignora outros parâmetros.

Listar períodos de faturamento

Use isto para preencher uma lista suspensa de janelas de assinaturas anteriores e atuais (cada entrada é um periodStartUnix que você pode transmitir com periodStartUnix=…). Os horários de término do período são inferidos (início do próximo período - 1 ou Stripe current_period_end para o período ativo).

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

Exemplo de resposta

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

Classificou o período mais recente primeiro. Um período aparece se houver uma chave de uso de ciclo ou se for o billing_period_start atual dos webhooks do Stripe.

O objeto billingCycle

Presente quando a expansão inclui billing_cycle ou includeBillingCycle está definido. Use-o para painéis: limite de renovação, uso na janela e créditos restantes incluídos.

CampoDescrição
periodStartUnixInício da janela de faturamento (segundos unix). Corresponde ao Stripe current_period_start quando a conta é sincronizada.
periodEndUnixFim da janela atual (segundos unix), ou seja, pouco antes da próxima renovação — Stripe current_period_end quando sincronizado. Não é o mesmo que a data de cancelamento da assinatura.
appUsage / apiUsageUso de créditos incluídos contado nesta janela: web/editor (aplicativo) versus chave de API (api). usedIncludedCredits é igual à soma deles.
includedCreditsSua cota de crédito incluída (no plano), conforme armazenada no Redis (mesma ideia dos créditos de nível superior).
prepaidCreditsSaldo pré-pago (comprado); não redefine cada período de faturamento.
usedIncludedCreditsUso total incluído na janela (aplicativo + API). O consumo pré-pago não é adicionado aqui.
remainingIncludedCreditsmax(0, IncludedCredits − usedIncludedCredits) para este instantâneo.
stripeBillingSyncedverdadeiro quando o Redis tem billing_period_start/end do Stripe para que a janela corresponda à sua assinatura; false significa que a API voltou para um mês UTC para este bloco.

Até que os webhooks do Stripe tenham escrito períodos de cobrança para o usuário, stripeBillingSynced poderá ser falso e a janela billingCycle seguirá o mês UTC. Após a sincronização, os limites de uso da API de imagem se alinham com as mesmas chaves de ciclo.

Para “créditos usados antes da próxima renovação”, ligue com expand=billing_cycle e use billingCycle.periodEndUnix como limite de renovação, billingCycle.usedIncludedCredits (ou appUsage + apiUsage) e billingCycle.remainingIncludedCredits. Adicione créditos pré-pagos se desejar saldo total disponível.

Exemplos (cURL)

Uso para um mês UTC específico

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

Ciclo de faturamento atual + bloco billingCycle completo (alinhado à renovação quando sincronizado)

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

Uma janela histórica de faturamento por início de período (de 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'
Exemplo JSON (com ciclo de faturamento)

app_usage e api_usage de nível superior sempre refletem o mês solicitado ou, quando periodStartUnix é definido, os contadores desse ciclo. Quando expand=billing_cycle é omitido, billingCycle está ausente.

{
  "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 é verdadeiro, billingCycle corresponde à aplicação na API de remoção de segundo plano. Quando falso, confie nos campos do mês do calendário ou espere até que os webhooks preencham billing_period_* no 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