List agents
integer
Page number. Default:
1.integer
Number of results per page. Default:
20, max: 100.Response
Create an agent
string
required
Display name for the agent.
string
required
The voice to use. See the Voice Library in your dashboard for available IDs.
string
Custom greeting the agent speaks when a call connects.
string
System prompt or persona instructions that guide the agent’s behavior.
string
ID of a knowledge base to link to this agent. See Knowledge base.
Response
Update an agent
Updates one or more fields on an existing agent. Only the fields you include are changed. Path parameterstring
required
The ID of the agent to update.
string
Updated display name.
string
Updated greeting message.
string
Set to
"active" or "paused". A paused agent will not answer calls.Response
Delete an agent
Permanently deletes an agent. This cannot be undone. Path parameterstring
required
The ID of the agent to delete.
Response