oauth
assets
albums
libraries
people
server
curl --request GET \
--url https://api.example.com/api/faces/{face_id}{
"id": "<string>",
"asset_id": "<string>",
"bounding_box": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"person_id": "<string>",
"timestamp_ms": 123,
"asset_urls": {},
"cluster_assignment": {
"distance_to_person": 123,
"candidates": [
{
"person_id": "<string>",
"distance": 123,
"name": "<string>"
}
]
}
}Get a face detection
Fetches one face’s details by ID (bounding box, assigned person, timestamps, thumbnail). Use when you already have a face_id.
curl --request GET \
--url https://api.example.com/api/faces/{face_id}{
"id": "<string>",
"asset_id": "<string>",
"bounding_box": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"person_id": "<string>",
"timestamp_ms": 123,
"asset_urls": {},
"cluster_assignment": {
"distance_to_person": 123,
"candidates": [
{
"person_id": "<string>",
"distance": 123,
"name": "<string>"
}
]
}
}Documentation Index
Fetch the complete documentation index at: https://docs.gumnut.ai/llms.txt
Use this file to discover all available pages before exploring further.
Path Parameters
Face ID (with face_ prefix) to fetch. Obtain from list_faces or from the faces array on get_asset / list_assets responses.
Query Parameters
Library the face belongs to. Optional if the user has a single library; required when they have multiple.
Comma-separated list of opt-in expansion fields. See list_faces for supported values.
Response
Successful Response
Represents a detected face in an asset with facial recognition data.
Unique face identifier with 'face_' prefix
ID of the asset containing this face
Face location as {x, y, w, h} coordinates in pixels
Show child attributes
Show child attributes
When this face was detected and recorded
When this face record was last updated
ID of the person this face belongs to (if identified)
For video files, timestamp in milliseconds when face appears
Asset variants for this face: 'thumbnail' with face crop
Show child attributes
Show child attributes
Cluster-assignment diagnostics for this face. Populated only when include=cluster_assignment is requested on the faces endpoint; null otherwise. See ClusterAssignmentResponse for the shape.
Show child attributes
Show child attributes