Skip to main content
POST
/
api
/
faceRecognition
/
faceEvent
/
getFaceEvent
Get face event
curl --request POST \
  --url https://api2.rhombussystems.com/api/faceRecognition/faceEvent/getFaceEvent \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "eventUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "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",
    "pitch": 15.5,
    "roll": 2.3,
    "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",
    "yaw": -5.7
  }
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for retrieving a specific face event by UUID.

eventUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing a specific face event.

faceEvent
object

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