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{
"data": [
{
"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"
}
],
"has_more": true
}List albums in a library, optionally filtered by asset membership or ID
Returns a paginated list of albums ordered by creation time (newest first). Use this to enumerate a user’s albums or to find which albums contain a specific asset (via asset_id).
list_albums returns album metadata only — to list the assets inside a particular album, use list_album_assets or list_assets with album_id.
Pagination is cursor-based: when has_more is true, pass the id of the last album in data as starting_after_id to fetch the next page.
curl --request GET \
--url https://api.example.com/api/albums{
"data": [
{
"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"
}
],
"has_more": true
}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 to list albums from. Optional if the user has a single library; required when they have multiple. Use list_libraries to enumerate.
Return only albums that contain this asset. Useful for answering 'which albums is this photo in?' without calling list_album_assets.
Look up specific albums by ID (max 100; each ID has the album_ prefix). Use for bulk fetch when IDs are already known.
Maximum number of albums to return per page (1–200). Defaults to 20.
1 <= x <= 200Cursor for pagination. Pass the id of the last album in the previous response's data to fetch the next page. Omit for the first page.