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 GET \
--url https://api.example.com/api/albums/{album_id}{
"id": "<string>",
"name": "<string>",
"asset_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"album_cover_asset_id": "<string>",
"asset_urls": {},
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z"
}Get metadata for a single album by ID
Fetches one album’s metadata (name, description, cover, counts). Use when you already have an album ID. Does not include the album’s assets — use list_album_assets or list_assets with album_id for that.
curl --request GET \
--url https://api.example.com/api/albums/{album_id}{
"id": "<string>",
"name": "<string>",
"asset_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"album_cover_asset_id": "<string>",
"asset_urls": {},
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z"
}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
Album ID (with album_ prefix) to fetch. Obtain from list_albums (optionally filtered by asset_id to find albums containing a specific asset), list_album_assets, or any response containing an album reference.
Response
Successful Response
Represents a collection of assets organized by the user.
Unique album identifier with 'album_' prefix
Display name of the album
Total number of assets in this album
When this album was created
When this album was last updated
Optional description text for the album
ID of the asset used as the album cover
Asset variants for the album cover: 'thumbnail'
Show child attributes
Show child attributes
The oldest asset date (local_datetime) in the album, or null if empty
The newest asset date (local_datetime) in the album, or null if empty