Create person record

POST /person/create


Description

The method creates a new person entry in the user's list (default or specified list). It supports multiple parameters for flexible integration and photo upload. A token is required, see Authorization.


Request format

  • HTTP method: POST
  • URL: /person/create
  • Content type: multipart/form-data

Authorization

Pass the token in one of two ways:

  • the token: <jwt-token> header — a temporary JWT token obtained with user/login;
  • the token field in the request body — a permanent API token (UUID) from your account.

Without a token the request returns 401 access denied.


Query Parameters

ParameterTypePassed inRequiredDescription
tokenstringform-data—Permanent API token (UUID), if the token header is not sent
list_idstringform-data❌ID of the list to which the person is added. The main list is used by default
group_idstringform-data❌Data source group ID
source_idstringform-data❌Data source ID
yawstring/numberform-data❌Face rotation angle left/right
pitchstring/numberform-data❌Face rotation angle up/down
feature_checkarray<string/object>form-data❌List of features detected on the face
new_person_thresholdanyform-data❌Threshold for matching a new face
new_person_square_minanyform-data❌Minimum face bounding box side length in pixels
new_person_yaw_maxanyform-data❌Maximum yaw angle for a new face
new_person_pitch_maxanyform-data❌Maximum pitch angle for a new face
new_person_threshold_scorestring/numberform-data❌Score matching threshold
fieldsarrayform-data❌Business fields to record
multibooleanform-data❌Process all faces in the photo
replace_on_foundbooleanform-data❌ID for replacing the record
thumbbooleanform-data❌Return thumbnail
normalizedbooleanform-data❌Return normalized image
bboxbooleanform-data❌Return face bounding box coordinates
bbox_probooleanform-data❌Return 4 bounding box points
drop_imagebooleanform-data❌Do not save the image in history
embedding_onlybooleanform-data❌Return only the embedding
embeddingstringform-data❌Vector representation of the face
  • One of the token transfer options is mandatory.

Example Request (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"

Example Answers

Success (200 OK)

{
  "faces_total": 0,
  "message": "image format is unknown",
  "spent": 97,
  "status": "ok"
}

Operation completed, but no records were added (201)

{
  "faces_total": 0,
  "matches": [],
  "message": "image format is unknown",
  "persons": [],
  "persons_new": 0,
  "persons_total": 0,
  "spent": 400,
  "status": "ok"
}

Error (400 Invalid schema)

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

Error (401 Unauthorized request)

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