libraries

Create a library

Changed on

Creates a new, empty photo library for the authenticated user. A library is the top-level container for assets, albums, people, and faces — most users have exactly one. Only create a new library when the user explicitly asks for a separate container.

post/api/libraries

Request

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

Request body

namestring required

Display name for the new library. Required.

descriptionstring nullable

Optional free-form description shown alongside the library name.

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 non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status