oauth
assets
- GETList assets in a library, optionally filtered by album, person, date range, or asset ID
- POSTUpload a new asset
- DELPermanently delete the specified assets and their underlying files
- GETGet asset counts
- POSTCheck asset existence
- POSTMove assets to trash
- POSTRestore assets from trash
- POSTPermanently delete every trashed asset in the library
- GETGet full metadata for a single asset by ID
- DELPermanently delete an asset and its underlying file
album-assets
albums
- GETList albums in a library, optionally filtered by asset membership or ID
- POSTCreate a new, empty album in a library
- GETGet metadata for a single album by ID
- DELDelete an album (the assets inside it are kept)
- PATCHRename an album or change its description
- POSTAdd existing assets to an album
- DELRemove assets from an album (assets themselves are kept)
libraries
faces
people
- GETList people in a library, optionally filtered by asset, album, name, or ID
- POSTCreate a new person record (a named identity for grouping faces)
- GETGet metadata for a single person by ID
- DELDelete a person record; its faces become unassigned and will be re-clustered
- PATCHUpdate a person's name, birth date, visibility, or thumbnail
- POSTMerge people
server
Delete a single face detection (keeps the asset and the person)
curl --request DELETE \
--url https://api.example.com/api/faces/{face_id}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}faces
Delete a single face detection (keeps the asset and the person)
Removes one face detection row. The underlying asset and the person this face was assigned to are both preserved.
Use update_face with person_id=null instead when the user wants to disassociate the face from a person without discarding the detection (so re-clustering can try again). Use delete_person to remove a person; use trash_assets (or permanently_delete_assets for irreversible removal) to remove the photo entirely.
DELETE
/
api
/
faces
/
{face_id}
Delete a single face detection (keeps the asset and the person)
curl --request DELETE \
--url https://api.example.com/api/faces/{face_id}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}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.
Get metadata for a single face detection by ID
Previous
Assign a face to a person, or detach it from its current person
Next
⌘I