Criador de fotos de documento API
PixMiller REST API · v1
Envie um retrato; a API remove o fundo do retrato, troca para uma cor de fundo de documento padrão e recorta conforme a especificação solicitada.
Este endpoint está em pré-visualização — a rota e os parâmetros estão sendo finalizados e podem mudar antes do lançamento. As convenções (autenticação X-Api-Key, resposta JSON) correspondem à API de remoção de fundo em produção.
POST
https://api.pixmiller.com/v1/id-photo
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 | Foto de retrato — de frente, iluminação uniforme |
spec
|
string | obrigatório | Especificação: 1inch / 2inch / us_passport / cn_visa … |
bg_color
|
string | opcional | Fundo: white (padrão) / blue / red |
2
Exemplos de código
Escolha um idioma e copie — funciona imediatamente.1curl -X POST "https://api.pixmiller.com/v1/id-photo" \2 -H "X-Api-Key: YOUR_API_KEY" \3 -F "[email protected]" \4 -F "spec=1inch" \5 -F "bg_color=blue"
1import requests23resp = requests.post(4 "https://api.pixmiller.com/v1/id-photo",5 headers={"X-Api-Key": "YOUR_API_KEY"},6 files={"image_file": open("face.jpg", "rb")},7 data={"spec": "1inch", "bg_color": "blue"},8)9print(resp.json()["url"])
1import fs from "node:fs";23const form = new FormData();4form.append("image_file", new Blob([fs.readFileSync("face.jpg")]), "face.jpg");5form.append("spec", "1inch");6form.append("bg_color", "blue");7const resp = await fetch("https://api.pixmiller.com/v1/id-photo", {8 method: "POST",9 headers: { "X-Api-Key": "YOUR_API_KEY" },10 body: form,11});12console.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.