agents

List paginated agent summaries.

Changed on
get/api/agent

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/agent
  • Auth: HTTP bearer

Query parameters

agent_nameAgentName[]

Optional agent name filters. Repeat the query parameter for multiple agents.

limitinteger

Maximum number of items to return.

page_tokenstring

Opaque pagination token from a previous response.

sort_by'name' | 'created_at'

Resource field used to order results before pagination.

sort_order'asc' | 'desc'

Sort direction. Defaults to ascending when sort_by is set.

Response

Paginated agent summaries.

next_page_tokenstring required

Changes

    • info

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

    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_order