List agents

The agents recording under your organisation.

Lists the agents registered to an organisation.

Request

  • GET /v1/organisations/{organisation}/agents

Parameters

Name In Type Required What it is
pageSize query integer no Maximum agents to return.
pageToken query string no A page token from a previous response, to retrieve the next page.

Response

Field Type What it is
agents list of object The agents in this page.
nextPageToken string Token to retrieve the next page, empty when there are no more.

Each item of the list

Field Type What it is
name string The resource name of the agent.
displayName string Human-readable name, e.g. Atlas.
service string The service the agent runs in, e.g. atlas-agent.
kind enum Whether this records a model-driven agent or an ordinary service that calls a model directly, such as a report generator or a document processor.
owner string Who to ask about this agent's spend.
product string Deprecated: no longer a budget-matching dimension.
components list of string The components this agent expects to report, e.g. chat_turn, tool:web_search.
tools list of string The tools this agent has, e.g. web_search, lookup_booking.
environment string The environment this agent's records that carry none are read as, e.g. organisations/acme/environments/development.
etag string Entity tag.
createTime timestamp When this agent was registered.
updateTime timestamp When this agent was last updated.

The OpenAPI document has every field. All methods.