Update a face.

Update a face

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

Unique identifier of face resource

Body Params
string
length between 1 and 128

Name of the person, as given by the user.

string
enum

State of the face, default is 'unknown'. A user can update an unknown\suggested face to a known face while the face recognition system can update an unkown face to suggested. Types of states:

  • known - user has added a new face or accepted a suggestion by the face recognition system. A user can also update an 'unknown' face to 'known' by giving it a name.
  • suggested - face suggested by recognition system. The system can decide to suggest a face that it has seen before. It is different from an 'unknown' face as here the clients should specifically ask end-users to approve or reject suggested faces, so a good balance should be found between suggesting any newly recognized face to the end-user vs only suggesting a single face out of a thousand. One way to make the suggested faces less likely to overload the end-user would be to count the number of faces that is currently in that state and to only suggest a new face if this count is below a threshold.
  • unknown - unrecognized face for which the recognition system has enough details to recognize it again in the future. When a user decides to forget a face, it can update its state to 'unknown' - these are then automatically deleted when the last event containing this face is deleted, and therefore we do not have a an api call to delete a face.
Allowed:
customData
object

The creator of the face/sample can add custom json data to the face/sample for their own use. This data will not be used by Eagle Eye Networks clients. To identify the system that added the data, the field is a key-value map, where the key is the namespace assigned to the application. This can have a maximum size of 1KB.

Responses
204

No Content

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json