> ## Documentation Index
> Fetch the complete documentation index at: https://docs.teamfollowup.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the public API base URL: https://api.teamfollowup.ai/api.
> Authenticate public API requests with Authorization: Bearer YOUR_API_KEY.
> Use product-owned terms: agents, campaigns, projects (GoHighLevel sub-accounts), contacts, calls, outcomes, skills, cadences, phone numbers.
> Scope requests by locationId rather than projectName.
> Read the guide linked from each API reference group before recommending an endpoint.

# Agents API

> Create, read, update, clone, test and delete agents. The agent is the voice; its campaign, under the same id, decides who it calls.

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](/agents/overview).

| Endpoint                                                                   | Use it to                                                                    |
| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| [List agent types](/api-reference/agents/list-agent-types)                 | See the three campaign types and the capabilities each can start with.       |
| [List agents](/api-reference/agents/list-agents)                           | Page through agents, filtered by `locationId` or `agentType`.                |
| [Create agent](/api-reference/agents/create-agent)                         | Create the agent and its campaign in one request. Accepts `Idempotency-Key`. |
| [Get agent](/api-reference/agents/get-agent)                               | Read the full `config` and the attached `campaign`.                          |
| [Update agent](/api-reference/agents/update-agent)                         | Change the `name` or any block of `config`.                                  |
| [Delete agent](/api-reference/agents/delete-agent)                         | Remove the agent and its campaign. Requires `cascade=agent_and_campaign`.    |
| [Clone agent](/api-reference/agents/clone-agent)                           | Copy the campaign, and optionally the agent, into another project.           |
| [Create test call](/api-reference/agents/create-test-call)                 | Have the agent phone you. A paid, real call.                                 |
| [Start a web test session](/api-reference/agents/start-a-web-test-session) | Talk to the agent in the browser.                                            |

Scopes: `agents:read`, `agents:write`, and `calls:write` for the two test
endpoints. See [Authentication](/authentication#scopes).

## Guides

* [Quickstart](/quickstart) creates an agent end to end.
* [Campaign types and capabilities](/agents/agent-types) explains `agentType`
  and `capabilityIds`.
* [The prompt](/agents/prompt), [The voice](/agents/voice) and
  [What your agent records](/agents/outcomes) map every `config` block.
* [Test your agent](/agents/test-your-agent) and [Clone an agent](/agents/clone-an-agent).
* [Glossary](/glossary#agents) for every field.