Reference
Agents
Save a specialist in the agent library. Instructions do not add tools or permissions.
An agent here is a Capsure specialist in the agent library. It is not an external coding agent, and this API does not post a chat message.
| Method | Path | What it does |
|---|---|---|
| GET | /api/v1/x/agents | Profiles you can see in this firm. Archived profiles stay out unless archived is true |
| GET | /api/v1/x/agents/{id} | One profile you can see, including an archived one. Anyone else is 404 |
| POST | /api/v1/x/agents | Create one |
| PUT | /api/v1/x/agents/{id} | Replace it |
| POST | /api/v1/x/agents/{id}/archive | Hide it |
Every call needs ai.agent.use.
name is required. You can also send description, instructions, writingStyle, personality, biases, lookFor, allowedGroups, allowWrites, writeActions, updateRecordTypes, outputs, templateIds, knowledge, visibility, and includePageContext.
allowedGroups is a list of tool groups: Research, Documents, Workspace, Records, Workflow, ESG, Legal, Investor relations, Portfolio, Assistant. IR is accepted as Investor relations. Any other name is 400 invalid_field, and nothing is stored.
Instructions are stored and shown to the in-app assistant. They do not override permissions, and they do not turn on a tool the firm has disabled. A profile that does not name a connector or a website in its knowledge does not receive connector tools. Listing one connector narrows the tools to that connector. There is no separate connector allow-list.
There is no route that runs the profile. Opening it is still a chat in the product.