Create a person

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

file

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

string

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

string

Optional name of the person.

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
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.

401

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

403

Forbidden - Insufficient permissions to access this resource

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
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json