Lists agents in the current workspace with pagination, sorted by created_at in descending order. Archived items are excluded by default; pass include_archived=true to include them.
Prerequisites
Endpoint and authentication configured. For details, see Overview and authentication.
Endpoint
GET /agents
Query parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
limit | No | int | Number of items per page. Default: 20, maximum: 100 |
page | No | string | Pagination cursor. Omit for the first request; pass the next_page value from the previous response to fetch the next page |
include_archived | No | bool | Whether to include archived agents. Default: false |
Request example
Response
The response contains data (an array of Agent objects) and next_page (cursor for the next page; null when no more data). Each Agent object has the same fields as the Create Agent response. Field descriptions:
Agent object fields
| Field | Type | Description |
|---|---|---|
id | string | Agent ID, format: agent_<ULID> |
type | string | Always agent |
version | int | Current version number, auto-incremented on each update |
name / description / system | string | Agent name, description, and system prompt |
model / tools / mcp_servers / skills / multiagent / metadata | object / array | Model, toolkits, MCP references, skills, multi-agent collaboration, and business metadata |
archived_at | string | null | Archive timestamp; null if not archived |
created_at / updated_at | string | Creation / last update time, ISO 8601 |
workspace_id | string | Workspace ID |