Получить запись персоны из списка

POST /person

Описание

Метод возвращает данные о персоне из заданного списка (по умолчанию или указанному). Для доступа нужен токен, см. раздел «Авторизация».

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

HTTP метод: POST
URL: /person
Тип контента: application/json

Авторизация

Токен передаётся одним из способов:

заголовок token: <jwt-token> — временный JWT-токен, полученный методом user/login;
поле token в теле запроса — постоянный API-токен (UUID) из личного кабинета.

Без токена запрос вернёт 401 access denied.

Тело запроса (JSON)

Поле	Тип	Обязательный	Описание
token	string	—	Постоянный API-токен (UUID), если нет заголовка `token`
list_id	string	✅	Идентификатор списка персон
limit	integer	❌	Максимальное количество возвращаемых записей
cursor	string	❌	Курсор для постраничного вывода
thumbs	bool	❌	Вернуть ли миниатюры изображений
embeddings	bool	❌	Вернуть ли эмбеддинги

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

curl -X POST "https://api.neuro-vision.ru/v1/person" -H "Content-Type: application/json" -H "token: <jwt-token>" -d '{"list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "limit": 10, "cursor": "", "thumbs": true, "embeddings": true}'

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

Успех (200 OK)

{
  "created": "2023-10-17T09:30:47Z",
  "features": {
    "eye_distance": 63,
    "eye_left": [10, 20],
    "eye_right": [73, 20],
    "gender": "male",
    "glasses": "none",
    "yaw": 0,
    "pitch": 0,
    "roll": 0,
    "facial_hair": "none"
  },
  "fields": [
    "Jim",
    "Carry",
    "21 Solter street",
    "New York"
  ],
  "group_id": "a53910d3-44c6-40a7-98f0-0a93772495fa",
  "image_url": "https://api.neuro-vision.ru/images/7114d3d0-94a0-11ea-930e-d601cafe23fd/random/token",
  "list_id": "1ad22a7e-e5de-4a50-b066-d9f00f81ff5f",
  "person_id": "55e2c7d0-951c-11ea-83be-36b62cef36f0",
  "source_id": "ccf4c6ca-95f3-4d73-8819-13918497e59e",
  "status": "init",
  "yaw": 45
}

Ошибка (400 Invalid schema)

{
  "message": "item with this id not found",
  "status": "error"
}

Ошибка (401 Unauthorized request)

{
  "message": "access denied",
  "status": "failed"
}

Ошибка (404 Invalid schema)

{
  "message": "item with this id not found",
  "status": "error"
}