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
Remove assets from an album (assets themselves are kept)
curl --request DELETE \
--url https://api.example.com/api/albums/{album_id}/assets \
--header 'Content-Type: application/json' \
--data '
{
"asset_ids": [
"<string>"
]
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}albums
Remove assets from an album (assets themselves are kept)
Detaches one or more assets from the given album. The assets remain in the library and in any other albums they belong to. Use trash_assets (or permanently_delete_assets for irreversible removal) to delete the asset entirely. To empty an album completely, call list_album_assets to get the links and then remove them, or delete the album itself with delete_album.
DELETE
/
api
/
albums
/
{album_id}
/
assets
Remove assets from an album (assets themselves are kept)
curl --request DELETE \
--url https://api.example.com/api/albums/{album_id}/assets \
--header 'Content-Type: application/json' \
--data '
{
"asset_ids": [
"<string>"
]
}
'{
"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.
Add existing assets to an album
Previous
Stream entity change events for client sync (use to keep a local cache in sync)
Next
⌘I