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

POST /persons

Описание

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

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

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

Авторизация

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

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

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

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

ПолеТипОбязательныйОписание
tokenstring—Постоянный API-токен (UUID), если нет заголовка token
list_idstring✅Идентификатор списка персон
limitinteger❌Максимальное количество возвращаемых записей
cursorstring❌Курсор для постраничного вывода
thumbsbool❌Вернуть ли миниатюры изображений
embeddingsbool❌Вернуть ли эмбеддинги

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

curl -X POST "https://api.neuro-vision.ru/v1/persons" -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)

{
  "status": "ok"
}

Ошибка (400 Bad Request)

{
  "message": "invalid schema",
  "status": "error"
}

Ошибка (401 Unauthorized)

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

Ошибка (404 Not Found)

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