List agents
List agents the caller has access to. Filter by team, search by name, or narrow to agents that use a specific tool or trigger. Results can be sorted with sort_order and paginated by sending page_size and/or cursor. Send summary=true to receive the lightweight AgentSummary shape instead of each agent’s whole configuration.
Authorizations
A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.
Query Parameters
Scope the listing to a single team. Get team IDs from List teams. When omitted, returns agents owned by the authenticated user; their team_id is the user's own ID.
When true, each item is an AgentSummary (identity, model, creator and activity fields) rather than the whole Agent configuration. Drops system_prompt, tools, resources and metadata, which make up most of a large team's list payload. Combine with page_size to browse a large team in small pages.
Response
Agents matching the provided filters.
Agent items by default; AgentSummary items when the request sent summary=true.
An agent and its whole configuration. Single-agent retrieve, create and update return this shape; the list endpoint does not populate the inlined collections, abilities or version. Collection-specific writes return their own result shapes.
- Option 1
- Option 2