List Agents
The eight agents with their settings, last activity and today's activity count.
API key access
agents:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/agentsAccess token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Header Parameters
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/agents" \ -H "X-Workspace-Id: string"{
"items": [
{
"key": "prospector",
"name": "string",
"stage": "string",
"description": "string",
"available": true,
"state": "coming_soon",
"enabled": true,
"paused": true,
"paused_at": "2019-08-24T14:15:22Z",
"autonomy": "suggest",
"max_autonomy": "suggest",
"auto_requires": "string",
"customer_facing": true,
"autonomy_effect": "string",
"triggers": [
"string"
],
"schedulable": true,
"schedule": {},
"next_run_at": "2019-08-24T14:15:22Z",
"pause_effect": "string",
"settings_href": "string",
"last_activity": {},
"runs_today": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"timezone": "string"
}Agent Activity
Job runs and timeline events of the agents (or one `agent`), newest first, last 30 days.
Update Agent
Turn an agent on or off, pause or resume it, set its autonomy or its schedule (Prospector). Admins only. Customer-facing agents are capped at `ask_first` (422 `autonomy_cap`); the Writer and the Inbox agent may be `auto` while Email approval is `none`, set by a person in the app only (403 `human_only` from Zero, MCP or an API key). Autonomy changes are audited (`agent.autonomy_changed`).