Agents

List all agents

Changed on

List every agent in the workspace, ordered by display_name and then by agent_id. Unlike agent search, the list does not depend on who an agent is shared with, so it includes private and disabled agents. Deleted agents are inactive and are left out unless an is_active filter includes the value "false". Use the agent_id of an active agent with other Platform APIs, for example as a usage limit target. A deleted agent is not a valid usage limit target. The caller must be able to read all agents, administer agents, or read workspace billing.

get/api/admin/agents

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/api/admin/agents
  • Auth: HTTP bearer

Query parameters

page_sizeinteger

Maximum number of agents to return. Defaults to 50. Maximum is 100.

cursorstring

Opaque pagination cursor from a previous response. Send the same filters that the previous request used.

JSON-encoded filters that choose which agents are returned. The only supported field is is_active, with the values "true" and "false" and the operator EQUALS. Multiple values OR within a filter. Multiple filters AND together. Without an is_active filter, only active agents are returned. To return active and deleted agents, send [{"field":"is_active","values":["true","false"]}].

Response

Successful response.

has_moreboolean required

Whether more agents are available after this page.

next_cursorstring nullable

Opaque cursor for the next page; null or absent when has_more is false.

request_idstring required

Request identifier for correlating this response.

Changes