Create an album
Creates an empty album, or reuses a matching album without changing it. The API checks names within the library, ignoring case and surrounding whitespace. Returns 201 for a new record or 200 for an existing matching name. Only supplied create fields must match; omitted fields leave existing values intact. A different supplied value returns 409 without changing the record; repeating that request does not resolve the conflict. Omitting the name uses the default name New Album. A new album starts empty; follow up with add_assets_to_album to populate it. A reused album may already contain assets. Does not delete existing records. To rename an existing album, use update_album instead of creating a new one.
Authorizations
Gumnut API key (apikey_...) sent as a Bearer token in the Authorization header. Create and manage keys in the Gumnut app, or with the API key endpoints while signed in to it.
Body
Display name for the new album. Optional; callers that need to name an album can set it here or via update_album after creation. If supplied, it must not be blank; surrounding whitespace is trimmed.
1 - 255Optional free-form description shown alongside the album name.
8192Library to create the album in. Optional if the user has a single live (non-trashed) library; required when they have multiple.
Response
Existing matching album
Represents a collection of assets organized by the user.
Unique album identifier with 'album_' prefix
Display name of the album. Names supplied as text on create or update are trimmed and must not be blank.
Total number of assets in this album
When this album was created
When this album was last updated
Optional description text for the album
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 variants for the album cover: 'thumbnail'
The oldest asset date (local_datetime) in the album, or null if empty
The newest asset date (local_datetime) in the album, or null if empty