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

POST /persons


Описание

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


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

  • HTTP метод: POST
  • URL: /persons
  • Тип контента: application/json
  • Авторизация: требуется

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

ПараметрТипГде передаётсяОбязательныйОписание
tokenstringHeaderJWT-токен пользователя

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

ПолеТипОбязательныйОписание
tokenstringJWT-токен пользователя
list_idstringИдентификатор списка персон
limitintegerМаксимальное количество возвращаемых записей
cursorstringКурсор для постраничного вывода
thumbsboolВернуть ли миниатюры изображений
embeddingsboolВернуть ли эмбеддинги

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

curl -X POST "https://api.neuro-vision.ru/v1/persons" 
  -H "Content-Type: application/json" 
  -H "Authorization: Bearer jwt.temporary.token" 
  -d '{
    "token": "jwt.temporary.token",
    "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"
}