albums

Updates album metadata (name, description, and/or cover). Changes overwrite current metadata; there is no automatic undo. Omitted fields and a null name are unchanged; a null description or cover clears that field. Does not delete the album or its assets. Renaming to another record's name in the same library returns 409. Names ignore case and surrounding whitespace; retrying the same collision does not resolve it. To modify the contents of an album, use add_assets_to_album / remove_assets_from_album instead — this tool only changes album metadata.

patch/api/albums/{album_id}

Request

  • Base URL
    https://api.gumnut.ai
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

album_idstring required

Album ID (with album_ prefix) of the album to rename or re-describe.

Request body

namestring nullable

New display name for the album; must not be blank. Surrounding whitespace is trimmed. Omit or pass null to leave unchanged.

descriptionstring nullable

New free-form description for the album. Pass null to clear the description. Omit to leave unchanged.

album_cover_asset_idstring nullable

Asset ID (with asset_ prefix) to use as the album cover. Must be a live asset already in the album. Pass null to clear the explicit cover. Omit to leave unchanged.

Response

Successful Response

idstring required

Unique album identifier with 'album_' prefix

namestring required

Display name of the album. Names supplied as text on create or update are trimmed and must not be blank.

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

    • breaking

      the / request property's minLength was increased from 0 to 1

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • breaking

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

    • info

      the response property became required for the status