Creatore foto documento API
PixMiller REST API · v1
Invia un ritratto; l'API rimuove lo sfondo del ritratto, lo sostituisce con un colore sfondo documento standard e ritaglia secondo la specifica richiesta.
Questo endpoint è in anteprima — la rotta e i parametri sono in fase di finalizzazione e possono cambiare prima del lancio. Le convenzioni (auth X-Api-Key, risposta JSON) corrispondono all'API di rimozione sfondo in produzione.
POST
https://api.pixmiller.com/v1/id-photo
1
Autenticazione e richiesta
Invia la tua chiave segreta nell'header della richiesta
X-Api-Key: YOUR_API_KEY. Crea e gestisci le chiavi nella tua pagina account.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
image_file
|
file | obbligatorio | Foto ritratto — frontale, illuminazione uniforme |
spec
|
string | obbligatorio | Specifica: 1pollice / 2pollici / us_passport / cn_visa … |
bg_color
|
string | facoltativo | Sfondo: bianco (predefinito) / blu / rosso |
2
Esempi di codice
Scegli una lingua e copia — funziona subito.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
Risposta
1{2 "url": "https://cdn.pixmiller.com/result/8Kd2pQ.png"3}
url
URL temporaneo dell'immagine elaborata (l'immagine sottostante viene eliminata automaticamente dopo 3 giorni).
4
Errori
Gli errori restituiscono il codice di stato corrispondente e un body JSON nella forma {"errors":{"code":"…","message":"…"}}.
400
validation error
image_file mancante o non valido, file troppo grande o fonti immagine in conflitto.
401
authentication_failed
L'intestazione X-Api-Key è mancante o non valida.
402
not_enough_credit
È stato richiesto size=full ma l'account non ha crediti HD disponibili.
422
invalid_image
L'immagine non è stata elaborata — troppo piccola, formato non supportato o decodifica non riuscita.
429
throttled
Limite di frequenza superato. Rallenta e riprova dopo l'intestazione Retry-After.