Update face event

Update face event.

POST /api/faceRecognition/faceEvent/updateFaceEvent

Update face event

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/faceRecognition/faceEvent/updateFaceEvent \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "eventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "personName": "<string>",
  "personUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

200

{
  "faceEvent": {
    "detectionConfidence": 0.98,
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "embeddingConfidence": 0.95,
    "eventTimestamp": 1640995200000,
    "faceName": "<string>",
    "hasEmbedding": true,
    "imageS3Key": "face-events/images/event_123.jpg",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "personUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "selectedPersonMatch": {
      "confidence": 0.95,
      "faceId": "face_12345",
      "name": "John Doe",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "thumbnailS3Key": "face-events/thumbnails/event_123.jpg",
    "topPersonMatches": [
      {
        "confidence": 0.95,
        "faceId": "face_12345",
        "name": "John Doe",
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for updating a face event with person association information.

eventUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

personName · string | null

Name of the person associated with the face event. Ignored if person UUID matches to one of the top person matches.

personUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for updating a face event.

faceEvent · object

External face event object containing face recognition data with person matches, embeddings, and metadata.

Show child attributes