libraries

Update a library

Changed on

Renames a library or changes its description. Only the fields included in the request body are changed. Library contents (assets, albums, people, faces) are not affected.

patch/api/libraries/{library_id}

Request

  • Base URL: https://api.gumnut.ai
  • URL: https://api.gumnut.ai/api/libraries/{library_id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

library_idstring required

Library ID (with lib_ prefix) of the library to update.

Request body

namestring nullable

New display name for the library. Omit to leave unchanged.

descriptionstring nullable

New free-form description for the library. Omit to leave unchanged.

Response

Successful Response

idstring required

Unique library identifier with 'lib_' prefix

namestring required

Display name of the library

descriptionstring nullable

Optional description text for the library

user_idstring required

ID of the user who owns this library

asset_countinteger required

Total number of assets in this library

storage_used_bytesinteger required

Bytes of assets currently stored in this library

storage_limit_bytesinteger nullable

Maximum bytes this library may store, or null if no per-library limit applies

created_atstring date-time required

When this library was created

updated_atstring date-time required

When this library was last updated

Changes

  • 815e0302a988Revision changes
    • 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

  • c3e15c78f2daRevision changes
    • info

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

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status