> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gumnut.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update an album

> Updates album metadata (name, description, and/or cover). Only the fields included in the request body are changed. To modify the contents of an album, use `add_assets_to_album` / `remove_assets_from_album` instead — this tool only changes album metadata.



## OpenAPI

````yaml https://api.gumnut.ai/openapi.json patch /api/albums/{album_id}
openapi: 3.1.0
info:
  title: Gumnut API
  description: API for using Gumnut to manage photos and videos
  version: 0.1.0
servers: []
security: []
paths:
  /api/albums/{album_id}:
    patch:
      tags:
        - albums
      summary: Update an album
      description: >-
        Updates album metadata (name, description, and/or cover). Only the
        fields included in the request body are changed. To modify the contents
        of an album, use `add_assets_to_album` / `remove_assets_from_album`
        instead — this tool only changes album metadata.
      operationId: update_album
      parameters:
        - name: album_id
          in: path
          required: true
          schema:
            type: string
            description: >-
              Album ID (with `album_` prefix) of the album to rename or
              re-describe.
            title: Album Id
          description: >-
            Album ID (with `album_` prefix) of the album to rename or
            re-describe.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlbumUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlbumResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AlbumUpdate:
      properties:
        name:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Name
          description: New display name for the album. Omit to leave unchanged.
        description:
          anyOf:
            - type: string
              maxLength: 8192
            - type: 'null'
          title: Description
          description: >-
            New free-form description for the album. Pass `null` to clear the
            description. Omit to leave unchanged.
        album_cover_asset_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Album Cover Asset Id
          description: >-
            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.
      type: object
      title: AlbumUpdate
    AlbumResponse:
      properties:
        id:
          type: string
          title: Id
          description: Unique album identifier with 'album_' prefix
        name:
          type: string
          title: Name
          description: Display name of the album
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Optional description text for the album
        asset_count:
          type: integer
          title: Asset Count
          description: Total number of assets in this album
        album_cover_asset_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Album Cover Asset Id
          description: >-
            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_urls:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/AssetVariant'
              type: object
            - type: 'null'
          title: Asset Urls
          description: 'Asset variants for the album cover: ''thumbnail'''
        start_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Start Date
          description: >-
            The oldest asset date (local_datetime) in the album, or null if
            empty
        end_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: End Date
          description: >-
            The newest asset date (local_datetime) in the album, or null if
            empty
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When this album was created
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: When this album was last updated
      type: object
      required:
        - id
        - name
        - asset_count
        - created_at
        - updated_at
      title: AlbumResponse
      description: Represents a collection of assets organized by the user.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AssetVariant:
      properties:
        url:
          type: string
          title: Url
          description: URL to fetch this image variant
        mimetype:
          type: string
          title: Mimetype
          description: MIME type of the served image
        width:
          anyOf:
            - type: integer
            - type: 'null'
          title: Width
          description: Target width in pixels (null if unknown)
      type: object
      required:
        - url
        - mimetype
      title: AssetVariant
      description: A single image variant with its URL, MIME type, and target width.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````