Create a person

post

https://access.lumana.ai/v3/face-api/persons

Creates a new person from a public face image URL or an uploaded file. Provide exactly one image source.

Required scope: write:faces

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The face image (public URL or uploaded file), an optional name and optional notes.

file

Face image upload (max 10MB; jpg, jpeg, png, webp). Provide this OR faceImageUrl.

faceImageUrl

string

Public URL of the face image. Provide this OR a file.

name

string

Optional name of the person.

notes

string

length ≤ 2000

Optional free-text notes about the person, for example why they are a person of interest, a police report number or the last contact. Up to 2000 characters. Notes are visible to everyone in the organization who can see the person.

groupId

string

Optional id of an existing people group to add the created person to. If the group does not exist the request fails with 404 and no person is created.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

No image source was provided, or the image URL is invalid, undownloadable, or an unsupported format.

404

The provided groupId does not exist; the person was not created.

409

A person matching this face already exists.

422

No face was detected in the image, or the image quality is too low to create a person.

500

Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

201The person has been successfully created.

401Unauthorized - Authentication is required and has failed or has not been provided.

403Forbidden - Insufficient permissions to access this resource