> ## 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, calls, campaigns, contacts, phone numbers, billing, and configuration.

# Team Follow Up API Reference

> Reference for Team Follow Up APIs: base URL, authentication, response conventions, and launched public modules.

Use this section to connect agents, calls, campaigns, contacts, phone numbers,
billing status, dashboard metrics, and platform configuration to your own
systems.

## What you can do

* Create, update, clone, and configure voice agents
* Read call records, call details, execution history, and test-call results
* Manage campaigns, campaign workflows, contacts, and power dialer actions
* Browse voices, phone numbers, projects, and approved platform configuration
* Read billing status, usage, balances, access subscriptions, and dashboard metrics

## Base URL

All REST API requests use this base URL:

```text theme={"dark"}
https://api.teamfollowup.ai/api
```

Endpoint pages include the `/api` prefix in their paths. For example:

```http theme={"dark"}
GET https://api.teamfollowup.ai/api/agent-builder/agents
```

## Authentication

Every public API request must include an API key as a bearer token:

```http theme={"dark"}
Authorization: Bearer YOUR_API_KEY
```

Create, rotate, and revoke keys from the **API Keys** page in the dashboard.
API keys are scoped by module, so a key can be limited to read-only access or to
specific workflow areas.

<Warning>
  Store API keys securely. Do not expose them in browser code, mobile bundles,
  client-side logs, screenshots, or support tickets.
</Warning>

## Response format

Successful responses use a JSON envelope:

```json theme={"dark"}
{
  "success": true
}
```

Many endpoints include a `data`, `result`, or resource-specific payload field.
Errors use the standard failure envelope:

```json theme={"dark"}
{
  "success": false,
  "error": "InsufficientScope",
  "message": "This API key does not have the required scope."
}
```

Common error status codes are `400`, `401`, `403`, `404`, `429`, and `500`.
Endpoint pages list the specific success and error responses for each route.

## SDKs and HTTP clients

The public API is REST over HTTPS and works with any standard HTTP client. Use
the examples on each endpoint page as the source of truth for request shape,
headers, and response bodies.

Official SDKs are not required for launch. When SDKs are available, this page
will link to setup and package documentation.

## Getting started

1. Create an API key from the dashboard.
2. Choose the minimum scopes your integration needs.
3. Make a test request with the bearer token.
4. Open the endpoint group you need from the sidebar.
5. Use endpoint examples and error responses while building your integration.

Start with agents if you are creating or managing voice agents:

```bash theme={"dark"}
curl https://api.teamfollowup.ai/api/agent-builder/agents \
  -H "Authorization: Bearer YOUR_API_KEY"
```