Skip to main content
An agent is a configured AI caller: its voice, language, opening line, script, the questions it asks and the labels it can give a call. You create and edit agents in the dashboard (Settings → AI calling); the API chooses which one makes each call with agent_id.

Listing agents

Only agents that are turned on and can call out are listed. Using one that is turned off returns 409 agent_disabled; an inbound-only agent returns 409 agent_inbound_only.

Personalising the call

Agent scripts contain placeholders in double braces, such as:
Hi , this is Riya from Shiksha Academy. You enquired about in — is this a good time?
You fill them per call:
  • {{name}} comes from contact.name. When uses_contact_name is true, always send it: an agent that does not know the name greets the person without it.
  • Everything else comes from variables. The variables list on each agent shows exactly which keys its script uses.
  • The agent also knows the current date and time on its own; you do not send those.

Rules for variables

Variables are spoken by the agent, so send them the way a person would say them: "NEET 2027", not "neet_2027_batch_b".
Keep data the agent should not say in metadata instead. It is stored with the call and returned to you, but never shown to the agent.

The contact