v64

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-016280256.4 KB
albums

Get an album

Fetches one album's metadata by ID (name, description, cover, counts). Use when you already have an album ID. The JSON response is metadata only and does not include the album's assets — to get the asset IDs or data, use list_album_assets or list_assets with album_id.

get/api/albums/{album_id}

Path parameters

album_idstring required

Album ID (with album_ prefix) to fetch.

Album ID (with album_ prefix) to fetch.

Response

Successful Response

idstring required

Unique album identifier with 'album_' prefix

namestring required

Display name of the album

descriptionstring nullable

Optional description text for the album

asset_countinteger required

Total number of assets in this album

album_cover_asset_idstring nullable

ID of the asset displayed as the album cover. May be a server-selected default when the album has no explicit cover set, or null when the album has no live assets.

asset_urlsobject nullable

Asset variants for the album cover: 'thumbnail'

start_datestring date-time nullable

The oldest asset date (local_datetime) in the album, or null if empty

end_datestring date-time nullable

The newest asset date (local_datetime) in the album, or null if empty

created_atstring date-time required

When this album was created

updated_atstring date-time required

When this album was last updated