Фото на документы API
PixMiller REST API · v1
Отправьте портрет; API удаляет фон портрета, заменяет его на стандартный цвет фона для документов и обрезает по запрашиваемой спецификации.
Эта конечная точка в режиме предварительного просмотра — маршрут и параметры финализируются и могут измениться до запуска. Конвенции (аутентификация X-Api-Key, JSON-ответ) совпадают с рабочим API удаления фона.
POST
https://api.pixmiller.com/v1/id-photo
1
Аутентификация и запрос
Отправьте ваш секретный ключ в заголовке запроса
X-Api-Key: YOUR_API_KEY. Создавайте и управляйте ключами на странице аккаунта.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
image_file
|
file | обязательный | Портретное фото — анфас, равномерное освещение |
spec
|
string | обязательный | Спецификация: 1inch / 2inch / us_passport / cn_visa … |
bg_color
|
string | необязательный | Фон: white (по умолчанию) / blue / red |
2
Примеры кода
Выберите язык и скопируйте — работает сразу.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
Ответ
1{2 "url": "https://cdn.pixmiller.com/result/8Kd2pQ.png"3}
url
Временный URL обработанного изображения (исходное изображение автоматически удаляется через 3 дня).
4
Ошибки
Ошибки возвращают соответствующий код статуса и JSON-тело в формате {"errors":{"code":"…","message":"…"}}.
400
validation error
Отсутствует или неверный image_file, файл слишком большой, или конфликтующие источники изображений.
401
authentication_failed
Заголовок X-Api-Key отсутствует или неверен.
402
not_enough_credit
Запрошен size=full, но на аккаунте не осталось HD-кредитов.
422
invalid_image
Изображение не удалось обработать — слишком маленькое, неподдерживаемый формат или ошибка декодирования.
429
throttled
Превышен лимит запросов. Снизьте частоту и повторите после заголовка Retry-After.