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/album-assets{
"data": [
{
"id": "<string>",
"album_id": "<string>",
"asset_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"has_more": true
}List album-asset link records (lightweight join rows between albums and assets)
Returns paginated link records describing which assets are in which albums — each row contains album_id + asset_id + link timestamps, not the full asset or album metadata. Use this when you specifically need the junction records (for sync or change tracking).
For most use cases you want a different tool: use list_assets with album_id to get the full asset metadata for a specific album; use list_albums with asset_id to find which albums contain an asset.
Pagination is cursor-based: when has_more is true, pass the id of the last album-asset in data as starting_after_id to fetch the next page.
curl --request GET \
--url https://api.example.com/api/album-assets{
"data": [
{
"id": "<string>",
"album_id": "<string>",
"asset_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "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
Return only link records for this album ID. Equivalent to 'list the assets in this album' — in most cases prefer list_assets with album_id to get the asset metadata directly instead of the lightweight link records.
Return only link records for this asset ID. Equivalent to 'which albums contain this asset' — in most cases prefer list_albums with asset_id to get the album metadata directly.
Look up specific album-asset link records by ID (max 100). The ID has the album_asset_ prefix.
Maximum number of link records per page (1–200). Defaults to 20.
1 <= x <= 200Cursor for pagination. Pass the id of the last album-asset in the previous response's data to fetch the next page. Omit for the first page.
Library to list from. Optional if the user has a single library; required when they have multiple.