Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Create, read, update, clone, test and delete agents. The agent is the voice; its campaign, under the same id, decides who it calls.
id.
Concepts are in What an agent is.
| Endpoint | Use it to |
|---|---|
| List agent types | See the three campaign types and the capabilities each can start with. |
| List agents | Page through agents, filtered by locationId or agentType. |
| Create agent | Create the agent and its campaign in one request. Accepts Idempotency-Key. |
| Get agent | Read the full config and the attached campaign. |
| Update agent | Change the name or any block of config. |
| Delete agent | Remove the agent and its campaign. Requires cascade=agent_and_campaign. |
| Clone agent | Copy the campaign, and optionally the agent, into another project. |
| Create test call | Have the agent phone you. A paid, real call. |
| Start a web test session | Talk to the agent in the browser. |
agents:read, agents:write, and calls:write for the two test
endpoints. See Authentication.
agentType
and capabilityIds.config block.