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
Get metadata for a single library by ID
curl --request GET \
--url https://api.example.com/api/libraries/{library_id}{
"id": "<string>",
"name": "<string>",
"user_id": "<string>",
"asset_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}libraries
Get metadata for a single library by ID
Fetches one library’s metadata (name, description, asset count). Use when you already have a specific library_id; for enumerating a user’s libraries prefer list_libraries.
GET
/
api
/
libraries
/
{library_id}
Get metadata for a single library by ID
curl --request GET \
--url https://api.example.com/api/libraries/{library_id}{
"id": "<string>",
"name": "<string>",
"user_id": "<string>",
"asset_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}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
Library ID (with lib_ prefix) to fetch. Obtain from list_libraries or any response containing a library reference.
Response
Successful Response
Represents a user's photo library.
Unique library identifier with 'lib_' prefix
Display name of the library
ID of the user who owns this library
Total number of assets in this library
When this library was created
When this library was last updated
Optional description text for the library
Create a new photo library for the authenticated user
Previous
Delete a library and all its contents — destructive, irreversible
Next
⌘I