RemBG Background Removal API — izstrādātāja dokumenti un integrācijas rokasgrāmata
Izpētiet visu API — izpildiet reālus pieprasījumus savā pārlūkprogrammā
Pārlūkojiet katru galapunktu, parametrus un atbildes. Izmēģiniet pieprasījumus ar savu API atslēgu, pēc tam jebkurā laikā iegūstiet neapstrādāto specifikāciju vietnē /api/openapi.
Palaist interaktīvo uzziņuFaila rembg.js instalēšana
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") |
Vides iestatīšana: Pārliecinieties, ka jūsu projekta saknē ir .env fails, kurā ir ietverta jūsu API atslēga.
Nepieciešamo moduļu importēšana: Sāciet ar funkcijas rembg importēšanu no @remove-background-ai/rembg.js un dotenv moduļa, lai apstrādātu vides mainīgos.
Progresa atzvanīšanas konfigurēšana: Bibliotēka piedāvā onDownloadProgress un onUploadProgress atzvanus, lai izsekotu failu darbību norisei. Norādītajā piemērā šie notikumi tiek reģistrēti tieši konsolē.
Tagad sīkāk apskatīsim lietojuma paraugu:
// 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();
});
Atcerieties, ka tīrīšanas funkciju var izsaukt, ja vēlaties noņemt apstrādāto attēlu no sava diska pēc fona noņemšanas.
Tiek rādīta progresa josla
Integrējot fona noņemšanas pakalpojumu, bieži vien ir lietderīgi sniegt lietotājiem atsauksmes par viņu augšupielādes vai lejupielādes pieprasījuma norisi. Lai to atvieglotu, varat definēt savus onDownloadProgress un onUploadProgress atzvanus. Abi šie atzvani pieņem AxiosProgressEvent kā notikuma parametru. Pieprasījuma izpildes laikā šie atzvani tiek izsaukti vairākas reizes, ļaujot, piemēram, parādīt norises joslu un pielāgot tās garumu atkarībā no norises.
(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)
Dalība un kredītu izmantošana
Atgriež jūsu plāna etiķeti, iekļauto un priekšapmaksas kredīta atlikumus un lietojumu. Varat veikt vaicājumu pēc UTC kalendārā mēneša (mantots), pēc svītrām saskaņota norēķinu perioda (pārraudzībai, veicot atjaunošanu) vai uzskaitīt zināmos norēķinu periodus. Autentificējieties tikai ar savu API atslēgu.
Shēmām, piemēriem un izmēģinājuma konsolei skatiet to pašu beigu punktu pilnajā atsaucē: Atvērt API dokumentus
Galapunkts
GET https://www.rembg.com/api/membership-usageAutentifikācija
Nosūtiet savu API atslēgu: galvene x-api-key: YOUR_API_KEY_HERE (izveidojiet un pārvaldiet atslēgas savā profilā vietnē rembg.com).
Vaicājuma parametri
| Parametrs | Ierakstiet | Apraksts |
|---|---|---|
| year | number | Kalendārais gads (1–9999). Mēnesī tiek rādīts Redis keys user:{uid}:app_usage:{year}:{month}. Ja tas ir izlaists (un periodStartUnix netiek izmantots), pēc noklusējuma tiek iestatīts pašreizējais UTC gads. |
| month | number (1–12) | Kalendāra 1.–12. mēnesis (atslēgām tiek izmantota UTC konvencija). Ja tas ir izlaists, pēc noklusējuma tiek iestatīts pašreizējais UTC mēnesis. |
| periodStartUnix | number | Unix laikspiedols sekundēs: norēķinu loga sākums. Nolasa user:{uid}:app_usage:cycle:{periodStartUnix} un api_usage:cycle:…. Nevar apvienot ar gadu vai mēnesi. |
| expand | string | Komatatdalīti karodziņi. Iekļaujiet billing_cycle, lai pievienotu objektu billingCycle: pašreizējais Stripe periods, kad programmā Redis pastāv billing_period_*, pretējā gadījumā pašreizējais UTC kalendārais mēnesis. Darbojas arī ar periodStartUnix konkrētam logam. |
| includeBillingCycle | 1 / true | Tas pats, kas izvērsts, kas satur billing_cycle: iestatiet uz 1 vai patiesu, lai iekļautu objektu billingCycle. |
| listBillingCycles | 1 / true | Īpašais režīms: listBillingCycles=1 vai patiess atgriež tikai { billingCycles: [...] }. Skenē Redis šī lietotāja cikla taustiņus; citi vaicājuma parametri šajā pieprasījumā tiek ignorēti. |
Nepāriet periodStartUnix kopā ar gadu vai mēnesi — API atgriež 400. ListBillingCycles režīms ir atsevišķs un ignorē citus parametrus.
Norēķinu periodu saraksts
Izmantojiet šo, lai aizpildītu iepriekšējo un pašreizējo abonēšanas logu nolaižamo izvēlni (katrs ieraksts ir periodStartUnix, kuru varat atgriezt ar periodStartUnix=…). Tiek izsecināti perioda beigu laiki (nākamā perioda sākums – 1 vai Stripe current_period_end aktīvajam periodam).
curl --location 'https://www.rembg.com/api/membership-usage?listBillingCycles=1' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Atbildes piemērs
{
"billingCycles": [
{
"periodStartUnix": 1774268612,
"periodEndUnix": 1776947012,
"appUsage": 120,
"apiUsage": 880
}
]
}Vispirms kārtots jaunākais periods. Punkts tiek parādīts, ja ir cikla lietošanas atslēga vai ja tas ir pašreizējais norēķinu_periods_sākums no Stripe tīmekļa aizķerēm.
BillingCycle objekts
Parādīt, ja ir iestatīts izvērsts ietver billing_cycle vai includeBillingCycle. Izmantojiet to informācijas paneļiem: atjaunošanas robežai, lietojumam logā un atlikušajiem iekļautajiem kredītiem.
| Lauks | Apraksts |
|---|---|
| periodStartUnix | Norēķinu loga sākums (unix sekundes). Atbilst Stripe current_period_start, kad konts ir sinhronizēts. |
| periodEndUnix | Pašreizējā loga beigas (unix sekundes), t.i., tieši pirms nākamās atjaunošanas — svītrojiet pašreizējo_periodu_beigas, sinhronizējot. Tas nav tas pats, kas abonementa atcelšanas datums. |
| appUsage / apiUsage | Šajā logā tiek skaitīts iekļautā kredīta lietojums: tīmekļa/redaktors (lietotne) pret API atslēgu (api). UseIncludedCredits ir vienāda ar to summu. |
| includedCredits | Jūsu iekļautā (plāna) kredīta piemaksa, kas saglabāta Redis (tā pati ideja kā augstākā līmeņa kredītiem). |
| prepaidCredits | Priekšapmaksas (pirkuma) atlikums; neatiestata katru norēķinu periodu. |
| usedIncludedCredits | Kopējais iekļautais lietojums logā (lietotne + API). Priekšapmaksas patēriņš šeit netiek pievienots. |
| remainingIncludedCredits | max(0, iekļautiKredīti − izmantotiIekļautie kredīti) šim momentuzņēmumam. |
| stripeBillingSynced | patiess, ja Redis ir norēķinu_perioda_sākums/beigas no Stripe, lai logs atbilstu jūsu abonementam; false nozīmē, ka API šim blokam ir atgriezies UTC kalendārajā mēnesī. |
Kamēr Stripe tīmekļa aizkari nav uzrakstījuši lietotāja norēķinu periodus, stripeBillingSynced var būt nepatiess un norēķinu cikla logs seko UTC kalendārajam mēnesim. Pēc sinhronizācijas attēla API lietošanas ierobežojumi tiek saskaņoti ar tiem pašiem cikla taustiņiem.
Lai saņemtu informāciju par “kredītiem, kas izmantoti pirms nākamās atjaunošanas”, izsauciet ar expand=billing_cycle un kā atjaunošanas robežu izmantojiet billingCycle.periodEndUnix, billingCycle.usedIncludedCredits (vai appUsage + apiUsage) un billingCycle.remainingIncludedCredits. Pievienojiet priekšapmaksas kredītus, ja vēlaties izmantot kopējo atlikumu.
Piemēri (cURL)
Lietojums konkrētam UTC kalendārajam mēnesim
curl --location 'https://www.rembg.com/api/membership-usage?year=2026&month=3' \ --header 'x-api-key: YOUR_API_KEY_HERE'
Pašreizējais norēķinu cikls + pilns norēķinu cikla bloks (sinhronizācijas laikā tiek veikta atjaunošana)
# 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'
Viens vēsturisks norēķinu logs pēc perioda sākuma (no listBillingCycles vai 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'
JSON piemērs (ar norēķinu ciklu)
Augstākā līmeņa app_usage un api_usage vienmēr atspoguļo pieprasīto kalendāro mēnesi vai, ja ir iestatīts periodStartUnix, šī cikla skaitītājus. Ja expand=billing_cycle ir izlaists, billingCycle nav.
{
"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
}
}Ja stripeBillingSynced ir patiess, billingCycle atbilst izpildei fona noņemšanas API. Ja vērtība ir nepatiesa, paļaujieties uz kalendārā mēneša laukiem vai uzgaidiet, līdz tīmekļa aizķeres aizpilda norēķinu_periods_* pakalpojumā 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