Sign in
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 live (non-trashed) 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

Changes

Changed in 3 of the 79 revisions of this API.125

  • 815e0302a98811See the full diff
    • ▲

      response property detail list-of-types was widened by adding types string to media type application/json of response 422

      response-property-list-of-types-widened

    • ○

      the response property became required for the status

      response-property-became-required

  • c3e15c78f2da4See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 0de36cb170df2See the full diff
    • ●

      the / request property's maxLength was set to 8192

      request-property-max-length-set

    • ●

      the / request property's maxLength was set to 255

      request-property-max-length-set