API Reference
AgentsEnterprise
Listing and retiring the agents people set up from the Portal.
An agent is the router and API key a person sets up for an AI tool from the Portal. The agents endpoints list active agents and retire them; agents are created from the Portal, not the API. See Managing Agents.
| Method | Path | Description | Scope |
|---|---|---|---|
| GET | /v1/agents | List active agents. Filter with person_id and router_id. Paginated. | agents:read |
| GET | /v1/agents/{id} | Get one agent. | agents:read |
| DELETE | /v1/agents/{id} | Retire an agent, with its router and API key. Needs a key of the account organization. | agents:delete |
Each agent has its wl_ id, person_id, router_id, token_id, profile_id and created_at.
| Code | Status | Meaning |
|---|---|---|
invalid_filter | 400 | A filter value is invalid. |
account_token_required | 403 | A delete uses a key of a named organization. |
router_scoped_token | 403 | The key is limited to some routers. |
agent_not_found | 404 | No active agent has that id. |
agent_router_has_aliases | 409 | The agent's router has aliases. Detach them first. |
Was this helpful?