Создать запись персоны

POST /person/create


Описание

Метод создает новую запись персоны в списке пользователя (по умолчанию или в указанном списке). Поддерживает множественные параметры для гибкой интеграции и загрузки фотографии. Для доступа необходим JWT-токен в заголовке или в теле запроса.


Формат запроса

  • HTTP метод: POST
  • URL: /person/create
  • Тип контента: multipart/form-data
  • Авторизация: требуется

Параметры запроса

ПараметрТипГде передаётсяОбязательныйОписание
tokenstringHeader, form-data✅*Перманентный токен пользователя. Если временный токен не указан в заголовке «token», то этот параметр обязателен в теле запроса
list_idstringform-dataИдентификатор списка, в который добавляется персона. По умолчанию используется основной список
group_idstringform-dataИдентификатор группы источников данных
source_idstringform-dataИдентификатор источника данных
yawstring/numberform-dataУгол поворота лица влево/вправо
pitchstring/numberform-dataУгол поворота лица вверх/вниз
feature_checkarray<string/object>form-dataСписок определяемых признаков на лице
new_person_thresholdanyform-dataПорог на совпадение нового лица
new_person_square_minanyform-dataМинимальный размер стороны лица в пикселях
new_person_yaw_maxanyform-dataМаксимальный yaw-угол для нового лица
new_person_pitch_maxanyform-dataМаксимальный pitch-угол для нового лица
new_person_threshold_scorestring/numberform-dataПорог совпадения по score
fieldsarrayform-dataБизнес-поля для записи
multibooleanform-dataОбработка всех лиц на фото
replace_on_foundbooleanform-dataID для замены записи
thumbbooleanform-dataВернуть миниатюру
normalizedbooleanform-dataВернуть нормализованное изображение
bboxbooleanform-dataВернуть координаты прямоугольника лица
bbox_probooleanform-dataВернуть 4 точки прямоугольника
drop_imagebooleanform-dataНе сохранять изображение в истории
embedding_onlybooleanform-dataВернуть только эмбеддинг
embeddingstringform-dataВекторное представление лица

* Один из вариантов передачи токена обязателен.


Пример запроса (cURL)

curl -X POST "https://api.neuro-vision.ru/v1/person/create" 
  -H "Authorization: Bearer jwt.temporary.token" 
  -F "list_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" 
  -F "group_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" 
  -F "source_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" 
  -F "fields=John" 
  -F "fields=Doe" 
  -F "multi=true" 
  -F "thumb=true" 
  -F "image=@/path/to/photo.jpg"

Примеры ответов

Успех (200 OK)
{
  "faces_total": 0,
  "message": "image format is unknown",
  "spent": 97,
  "status": "ok"
}
Операция выполнена, но записи не добавлены (201)
{
  "faces_total": 0,
  "matches": [],
  "message": "image format is unknown",
  "persons": [],
  "persons_new": 0,
  "persons_total": 0,
  "spent": 400,
  "status": "ok"
}
Ошибка (400 Invalid schema)
{
  "message": "invalid schema",
  "status": "error"
}
Ошибка (401 Unauthorized request)
{
  "message": "access denied",
  "status": "failed"
}