Skip to main content
PATCH
/
api
/
faces
/
{face_id}
{
  "id": "<string>",
  "asset_id": "<string>",
  "person_id": "<string>",
  "bounding_box": {},
  "timestamp_ms": 123,
  "thumbnail_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

​
face_id
string
required

Query Parameters

​
library_id
string | null

Library ID (required if user has multiple libraries)

Body

application/json
​
person_id
string | null

Response

Successful Response

Represents a detected face in an asset with facial recognition data.

​
id
string
required

Unique face identifier with 'face_' prefix

​
asset_id
string
required

ID of the asset containing this face

​
bounding_box
object
required

Face location as {x, y, w, h} coordinates in pixels

​
created_at
string<date-time>
required

When this face was detected and recorded

​
updated_at
string<date-time>
required

When this face record was last updated

​
person_id
string | null

ID of the person this face belongs to (if identified)

​
timestamp_ms
integer | null

For video files, timestamp in milliseconds when face appears

​
thumbnail_url
string | null

URL to get a cropped thumbnail of just this face

⌘I