v2
library
private

List Library Agents

Get all agents in the user's library (both created and saved).

get/api/library/agents

Query parameters

search_termstring nullable

Search term to filter agents

Search term to filter agents

sort_by'createdAt' | 'updatedAt' | 'lastRunAt'

Possible sort options for sorting library agents.

Criteria to sort results by

pageinteger

Page number to retrieve (must be >= 1)

Page number to retrieve (must be >= 1)

page_sizeinteger

Number of agents per page (must be >= 1)

Number of agents per page (must be >= 1)

folder_idstring nullable

Filter by folder ID

Filter by folder ID

include_root_onlyboolean

Only return agents without a folder (root-level agents)

Only return agents without a folder (root-level agents)

is_hiddenboolean nullable

Filter by hidden status. True = only hidden, False = only non-hidden, omit = all agents.

Filter by hidden status. True = only hidden, False = only non-hidden, omit = all agents.

Response

Successful Response

Example response

{
  "pagination": {
    "total_items": 42,
    "total_pages": 2,
    "current_page": 1,
    "page_size": 25
  }
}

Changes

Changed in 7 of the 165 revisions of this API.57

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the new enum value lastRunAt to the query request parameter sort_by

      request-parameter-enum-value-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the new optional query request parameter is_hidden

      new-optional-request-parameter

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ●

      deleted the query request parameter is_hidden

      request-parameter-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the new optional query request parameter is_hidden

      new-optional-request-parameter

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ●

      deleted the query request parameter is_hidden

      request-parameter-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 96 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog