Faces
Faces detected in a photo. A face is a detection until it is linked to a person — naming and merging are in People.
List faces
Beta — this operation may change on 30 days notice. See versioning.
Returns the faces detected in one photo, most confident first, each with the person it was matched to. fd_low_quality marks a face too blurry to match reliably.
path Parameters
idquery Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetsort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List faces › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Delete a face
Beta — this operation may change on 30 days notice. See versioning.
Removes a detection that is not a face, or not one worth keeping. The photo is untouched.
path Parameters
face_ididHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a face › Responses
Success
Update a face
Beta — this operation may change on 30 days notice. See versioning.
Adjusts the detection itself — its box or how it is treated. Who it belongs to is set separately.
path Parameters
face_ididHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a face › Request Body optional
fd_agefd_genderfd_expressionUpdate a face › Responses
Success
Link a face to a person
Beta — this operation may change on 30 days notice. See versioning.
Links this detection to a person. A detection belongs to the file it was found in; the person is a separate resource, and this is the link between them.
path Parameters
face_ididHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Link a face to a person › Responses
Success
Search files by face
Beta — this operation may change on 30 days notice. See versioning.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Search files by face › Request Body optional
thresholdlimit^-?[0-9]+(\.[0-9]+)?…offset^-?[0-9]+(\.[0-9]+)?…Search files by face › Responses
Success