libraries

List libraries

Changed on

Returns libraries owned by the authenticated user (no pagination — users typically have one or a handful). Call this when another tool's library_id parameter is required but you don't yet know which libraries exist. A single-library user can usually omit library_id on other tools entirely.

By default trashed libraries are excluded. Pass state=trashed to list the trash drawer (ordered by most recently trashed) or state=all for both.

get/api/libraries

Request

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

Query parameters

state'live' | 'trashed' | 'all'

Which set of libraries to return: live (default — excludes trashed), trashed (only trashed, ordered by most recently trashed), or all (both).

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