Create persona 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. Access requires a JWT token in the header or request body.

Request format

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

Query Parameters

Parameter	Type	Passed in	Required	Description
token	string	Header, form-data	✅*	Permanent user token. If a temporary token is not specified in the “token” header, then this parameter is required in the request body
list_id	string	form-data	❌	ID of the list to which the person is added. The main list is used by default
group_id	string	form-data	❌	Data source group ID
source_id	string	form-data	❌	Data source ID
yaw	string/number	form-data	❌	Face rotation angle left/right
pitch	string/number	form-data	❌	Face rotation angle up/down
feature_check	array<string/object>	form-data	❌	List of features detected on the face
new_person_threshold	any	form-data	❌	Threshold for matching a new face
new_person_square_min	any	form-data	❌	Minimum face bounding box side length in pixels
new_person_yaw_max	any	form-data	❌	Maximum yaw angle for a new face
new_person_pitch_max	any	form-data	❌	Maximum pitch angle for a new face
new_person_threshold_score	string/number	form-data	❌	Score matching threshold
fields	array	form-data	❌	Business fields to record
multi	boolean	form-data	❌	Process all faces in the photo
replace_on_found	boolean	form-data	❌	ID for replacing the record
thumb	boolean	form-data	❌	Return thumbnail
normalized	boolean	form-data	❌	Return normalized image
bbox	boolean	form-data	❌	Return face bounding box coordinates
bbox_pro	boolean	form-data	❌	Return 4 bounding box points
drop_image	boolean	form-data	❌	Do not save the image in history
embedding_only	boolean	form-data	❌	Return only the embedding
embedding	string	form-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 "Authorization: Bearer jwt.temporary.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"
}