Remover fundo API
PixMiller REST API · v1
Envie uma imagem; a IA remove o fundo e retorna um PNG transparente. Síncrono — geralmente alguns segundos.
POST
https://api.pixmiller.com/v1/remove
1
Autenticação e requisição
Envie sua chave secreta no cabeçalho da requisição
X-Api-Key: YOUR_API_KEY. Crie e gerencie chaves na sua página de conta.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
image_file
|
file | obrigatório* | Imagem para processar, upload multipart. JPG / PNG / WebP, até 20 MB |
image_url
|
string | obrigatório* | Ou uma URL pública de imagem (forneça image_file ou image_url) |
size
|
string | opcional | preview (gratuito, com marca d'água) / full (HD, 1 crédito) / auto. Padrão: preview |
format
|
string | opcional | auto (PNG se transparente, caso contrário JPG — padrão) / png / jpg |
bg_color
|
string | opcional | Fundo do resultado: transparente (padrão) / white / qualquer #RRGGBB |
2
Exemplos de código
Escolha um idioma e copie — funciona imediatamente.1curl -X POST "https://api.pixmiller.com/v1/remove" \2 -H "X-Api-Key: YOUR_API_KEY" \3 -F "[email protected]" \4 -F "size=full"
1import requests23resp = requests.post(4 "https://api.pixmiller.com/v1/remove",5 headers={"X-Api-Key": "YOUR_API_KEY"},6 files={"image_file": open("product.jpg", "rb")},7 data={"size": "full"},8)9print(resp.json()["url"])
1import fs from "node:fs";23const form = new FormData();4form.append("image_file", new Blob([fs.readFileSync("product.jpg")]), "product.jpg");5form.append("size", "full");6const resp = await fetch("https://api.pixmiller.com/v1/remove", {7 method: "POST",8 headers: { "X-Api-Key": "YOUR_API_KEY" },9 body: form,10});11console.log((await resp.json()).url);
3
Resposta
1{2 "url": "https://cdn.pixmiller.com/result/8Kd2pQ.png"3}
url
URL temporária da imagem processada (a imagem original é excluída automaticamente após 3 dias).
4
Erros
Os erros retornam o código de status correspondente e um corpo JSON no formato {"errors":{"code":"…","message":"…"}}.
400
validation error
image_file ausente ou inválido, arquivo muito grande ou fontes de imagem conflitantes.
401
authentication_failed
O cabeçalho X-Api-Key está ausente ou é inválido.
402
not_enough_credit
size=full foi solicitado, mas a conta não possui créditos HD disponíveis.
422
invalid_image
A imagem não pôde ser processada — muito pequena, formato não suportado ou falha na decodificação.
429
throttled
Limite de requisições excedido. Aguarde e tente novamente após o cabeçalho Retry-After.
5
Migrating from remove.bg
Change the base URL — your existing request keeps working.
remove.bg stops accepting self-serve API requests on 2026-12-01. PixMiller mirrors its main path at
POST /v1.0/removebg — same X-Api-Key header, same parameter names, HTTP 200 with the image bytes in the body. A matching GET /v1.0/account returns your credit balance.
1curl -H "X-Api-Key: REMOVEBG_KEY" \2 -F "[email protected]" \3 -F "size=auto" \4 -o out.png \5 https://api.remove.bg/v1.0/removebg
1curl -H "X-Api-Key: PIXMILLER_KEY" \2 -F "[email protected]" \3 -F "size=auto" \4 -o out.png \5 https://api.pixmiller.com/v1.0/removebg
| remove.bg value | PixMiller tier | Descrição |
|---|---|---|
preview / small / regular
|
preview | Watermarked preview, up to 640 px. Free — no credit charged. This is the default, as on remove.bg. |
medium / hd / 4k / full / 50MP
|
full | Full-resolution, watermark-free result, downscaled to the tier's megapixel cap (1.5 / 4 / 25 / 25 / 50 MP; PNG output is capped at 10 MP). 1 credit per image. |
auto
|
auto | Full resolution when credits are available, free watermarked preview otherwise. |
X-Credits-Charged
Credits actually deducted by this call (0 for the free preview tier).
X-Width / X-Height
Pixel dimensions of the returned image.
X-Type
Detected foreground class: person, product, animal, car or other (omitted with type_level=none).
X-Foreground-Top / -Left / -Width / -Height
Bounding box of the subject in the returned image.
X-RateLimit-Limit / -Remaining / -Reset
Rate limit state for your key, counted per image — one call uses one unit; Retry-After is added on 429.
Every remove.bg parameter is accepted and validated — size, type, type_level, format, roi, crop, crop_margin, scale, position, channels, bg_color, bg_image_url and bg_image_file behave as documented by remove.bg. These are accepted but never change the output, as on remove.bg for non-car subjects:
shadow_type, shadow_opacity, add_shadow, semitransparency
- size=preview (and its aliases small / regular — the default, as on remove.bg) returns our free, watermarked preview at up to 640 px and costs no credit; remove.bg returns a 0.25-megapixel image without watermark for 0.25 credits.
- medium, hd, 4k, full and 50MP all cost 1 credit, as on remove.bg. There is no free monthly preview quota, so /v1.0/account always reports free_calls = 0.
- X-Type is a coarse class (person / product / animal / car / other) derived from the segmentation model that was used; type_level = 2 and latest return the same coarse classes.
- Shadows (shadow_type / shadow_opacity / add_shadow) and car-window semitransparency are accepted but never rendered — as on remove.bg for non-car subjects.
- Input files are limited to 20 MB (remove.bg: 22 MB).
Errors on this endpoint use the remove.bg JSON:API envelope {"errors":[{"title":"…","code":"…"}]}
with 400 invalid_parameter / 402 insufficient_credits / 403 auth_failed / 429 rate_limit_exceeded.
This is a compatibility layer for the main HTTP path, not a certified drop-in for the official SDKs or CLI.