Agents API

An agent is the rep that makes the calls: its prompt, voice, skills and what it records. Every agent has one campaign attached, reachable through the same id. Concepts are in What an agent is.

Endpoint	Use it to
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.
Create web agent session	Talk to the agent in the browser.

The three campaign types and the capabilities each can start with are a fixed set, validated by Create agent rather than listed by an endpoint. They are spelled out in Campaign types and capabilities. Scopes: agents:read, agents:write, and calls:write for the two test endpoints. See Authentication.

Guides

Quickstart creates an agent end to end.
Campaign types and capabilities explains agentType and capabilityIds.
The prompt, The voice and What your agent records map every config block.
Test your agent and Clone an agent.
Glossary for every field.

TFU Live has a dedicated complete-agent authoring contract and API reference.

Developer setup

Agents

TFU Live

In-call Capabilities

Campaigns

Master agent

Phone Numbers

Voices

Projects

Calls

Contacts

Native Contacts

Native Calendar

Analytics

Billing

Guides

​Guides

Guides