Vectors

POST /vector/search


Description

The method compares biometric (photo) vectors with vectors of persons from the specified lists. JWT token is required in the header for access.


Request format

  • HTTP method: POST
  • URL: /vector/search
  • Content type: application/json
  • Authorization: required

Query Parameters

ParameterTypePassed InRequiredDescription
tokenstringHeaderUser’s JWT token

Request Body (JSON)

FieldTypeRequiredDescription
tokenstringUser’s JWT token
embeddingsstringBiometric vector (or string of vectors)
list_idsstringID(s) of person lists for search
thresholdstringMatch threshold
person_databooleanWhether to return data of found persons
resultsstringResult format (e.g., “all”, “top”)

Example Request (cURL)

curl -X POST "https://api.neuro-vision.ru/v1/vector/search" 
  -H "Content-Type: application/json" 
  -H "Authorization: Bearer jwt.temporary.token" 
  -d '{
    "token": "jwt.temporary.token",
    "embeddings": "0.123,0.456,0.789",
    "list_ids": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "threshold": "0.7",
    "person_data": true,
    "results": "top"
  }'

Example Answers

Success (200 OK)
{
  "results": [
    {
      "additionalProp1": {}
    }
  ],
  "status": "ok"
}
Error (400 Invalid input)
{
  "message": "invalid input",
  "status": "error"
}