Sign in

v64

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

Create an album

Creates a new, empty album in a library (with optional name and description) and returns it. The album starts empty — follow up with add_assets_to_album to populate it. To rename an existing album, use update_album instead of creating a new one.

post/api/albums

Request body

namestring nullable

Display name for the new album. Optional; callers that need to name an album can set it here or via update_album after creation.

descriptionstring nullable

Optional free-form description shown alongside the album name.

library_idstring nullable

Library to create the album in. Optional if the user has a single library; required when they have multiple.

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