POST /person/create
Описание
Метод создает новую запись персоны в списке пользователя (по умолчанию или в указанном списке). Поддерживает множественные параметры для гибкой интеграции и загрузки фотографии. Для доступа нужен токен, см. раздел «Авторизация».
Формат запроса
- HTTP метод:
POST - URL:
/person/create - Тип контента:
multipart/form-data
Авторизация
Токен передаётся одним из способов:
- заголовок
token: <jwt-token>— временный JWT-токен, полученный методомuser/login; - поле
tokenв теле запроса — постоянный API-токен (UUID) из личного кабинета.
Без токена запрос вернёт 401 access denied.
Параметры запроса
| Параметр | Тип | Где передаётся | Обязательный | Описание |
|---|---|---|---|---|
| token | string | form-data | — | Постоянный API-токен (UUID), если нет заголовка token |
| list_id | string | form-data | ❌ | Идентификатор списка, в который добавляется персона. По умолчанию используется основной список |
| group_id | string | form-data | ❌ | Идентификатор группы источников данных |
| source_id | string | form-data | ❌ | Идентификатор источника данных |
| yaw | string/number | form-data | ❌ | Угол поворота лица влево/вправо |
| pitch | string/number | form-data | ❌ | Угол поворота лица вверх/вниз |
| feature_check | array<string/object> | form-data | ❌ | Список определяемых признаков на лице |
| new_person_threshold | any | form-data | ❌ | Порог на совпадение нового лица |
| new_person_square_min | any | form-data | ❌ | Минимальный размер стороны лица в пикселях |
| new_person_yaw_max | any | form-data | ❌ | Максимальный yaw-угол для нового лица |
| new_person_pitch_max | any | form-data | ❌ | Максимальный pitch-угол для нового лица |
| new_person_threshold_score | string/number | form-data | ❌ | Порог совпадения по score |
| fields | array | form-data | ❌ | Бизнес-поля для записи |
| multi | boolean | form-data | ❌ | Обработка всех лиц на фото |
| replace_on_found | boolean | form-data | ❌ | ID для замены записи |
| thumb | boolean | form-data | ❌ | Вернуть миниатюру |
| normalized | boolean | form-data | ❌ | Вернуть нормализованное изображение |
| bbox | boolean | form-data | ❌ | Вернуть координаты прямоугольника лица |
| bbox_pro | boolean | form-data | ❌ | Вернуть 4 точки прямоугольника |
| drop_image | boolean | form-data | ❌ | Не сохранять изображение в истории |
| embedding_only | boolean | form-data | ❌ | Вернуть только эмбеддинг |
| embedding | string | form-data | ❌ | Векторное представление лица |
- Один из вариантов передачи токена обязателен.
Пример запроса (cURL)
curl -X POST "https://api.neuro-vision.ru/v1/person/create" -H "token: <jwt-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"
}