oauth
assets
albums
libraries
people
server
curl --request GET \
--url https://api.example.com/api/people/{person_id}{
"id": "<string>",
"is_hidden": true,
"is_favorite": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"birth_date": "2023-12-25",
"asset_count": 123,
"thumbnail_face_id": "<string>",
"asset_urls": {},
"cluster_metrics": {
"pairwise_p90": 123,
"pairwise_mean": 123,
"face_count": 123
}
}Get a person
Fetches one person’s metadata by ID (name, asset count, thumbnail, etc.). Use this when you already have a person_id. To find photos that contain this person, use search_assets with person_ids or list_assets with person_id.
curl --request GET \
--url https://api.example.com/api/people/{person_id}{
"id": "<string>",
"is_hidden": true,
"is_favorite": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"birth_date": "2023-12-25",
"asset_count": 123,
"thumbnail_face_id": "<string>",
"asset_urls": {},
"cluster_metrics": {
"pairwise_p90": 123,
"pairwise_mean": 123,
"face_count": 123
}
}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
Person ID (with person_ prefix) to fetch. Obtain from list_people, get_face.person_id, or any response containing a person reference.
Query Parameters
Comma-separated list of opt-in expansion fields. See list_people for supported values.
Response
Successful Response
Represents a person identified through face clustering and recognition.
Unique person identifier with 'person_' prefix
Whether this person should be hidden from the UI
Whether this person is marked as a favorite
When this person record was created
When this person record was last updated
Optional name assigned to this person
Optional birth date of this person
Number of unique photos this person appears in, or null if not computed
ID of the face resource used as this person's thumbnail
Asset variants from this person's thumbnail face. May be null when embedded in an AssetResponse; use /api/people endpoints for full person data.
Show child attributes
Show child attributes
Cohesion metrics for this person's face cluster. Populated only when include=cluster_metrics is requested on the people endpoint, and only for persons with a populated centroid (newly-created empty Persons will have null). See ClusterMetricsResponse for the shape.
Show child attributes
Show child attributes