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
curl --request POST \
--url https://api.example.com/api/assets/trash \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"<string>"
]
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Move assets to trash
Soft-deletes the given assets. Trashed assets are excluded from default list/search results and are purged after the configured retention window. Reversible via restore_assets until purge.
Use this for the user’s standard ‘delete’ action. To delete forever in one step, use permanently_delete_assets instead — but prefer trash so the user can recover from accidental deletes.
curl --request POST \
--url https://api.example.com/api/assets/trash \
--header 'Content-Type: application/json' \
--data '
{
"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.
Query Parameters
Library that owns the assets. Optional if the user has a single library; required when they have multiple.
Body
Request body carrying a list of asset IDs for the bulk trash, restore, and permanent-delete endpoints.
Asset IDs (each with the asset_ prefix) to operate on. Up to 100 ids per request.
1 - 100 elementsResponse
Successful Response