> ## 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. # List available tools > List both available **capabilities and platform tools** in one catalog. Appointment Booking, Live Transfer and Add a Tag are included here; they do not need a separate capability-list endpoint. Capabilities bundle an in-call action with its supported settings and related behavior. They share discovery with other tools, while their configuration has its own section in [Update campaign](/api-reference/campaigns/update-campaign). | Catalog entry | Kind | Update campaign field | | --- | --- | --- | | Appointment Booking | Capability | `capabilities.appointment_booking` | | Service Area Check | Tool | `tools.smart_service_area` | | Live Transfer | Capability | `capabilities.live_transfer` | | Add a Tag | Capability | `capabilities.add_tag` | | Check a Tag | Tool | `tools.check_tag` | Use [Get campaign](/api-reference/campaigns/get-campaign) to read installed `capabilities` and `tools`. This catalog lists what is available, not what is installed. A campaign may have zero capabilities. To install an entry, send `enabled: true` and its required settings in the corresponding Update campaign field. Omitted entries stay unchanged; `null` removes one. For stale-edit protection, optionally send `campaign.metadata.inventoryVersion` from Get campaign as `expectedVersion`. The Update campaign schema defines the supported configuration; individual skill endpoints remain available for targeted skill editing. The catalog `name` is a display label, such as "Live Transfer". It is not the `toolName` for Update a tool description. Use [Get agent](/api-reference/agents/get-agent) with `view=tools` and copy the exact installed `tools[].name`, such as `transfer_call`. A single catalog entry can create multiple installed tools. Custom instruction playbooks are described in the documentation. Required API key scope: `agents:read`. ## OpenAPI ````yaml /openapi.yaml get /api/agent-builder/tools openapi: 3.1.0 info: title: TFUAI Server API version: 1.0.0 description: >- API reference for the TFUAI SaaS server. All published endpoints are mounted under `/api`. Responses use a standard envelope: `{ "success": true, ... }` on success and `{ "success": false, "error": "..." }` on failure. Product API modules are being launched module by module. This spec currently exposes only contracted public modules. Authenticate public API requests with an API key in the `Authorization` header: `Authorization: Bearer YOUR_API_KEY`. servers: - url: https://api.teamfollowup.ai description: Production API origin. Public API paths are under /api. security: [] tags: - name: Agents description: >- Build the conversation: identity and settings, script, lead context and split testing. - name: Analytics description: >- Understand call volume, pickup, booking and transfer metrics within the selected reporting scope. - name: Billing description: >- Balances, spend, purchases and sub-account rebilling. Reference and guides only; the builder chatbot has no billing playbook. - name: Calls description: >- Review completed calls, recordings, transcripts and campaign run history; distinguish observation from placing a new call. - name: Campaigns description: >- Configure what starts calls, who is eligible, calling windows, caller IDs, activation and the actions that follow each outcome. What runs after a call lands: for each outcome (booked, opted out, asked for a callback…), an ordered chain of actions — tag the contact, move a pipeline stage, send an SMS, book an appointment. Stored as a graph: `nodes` are the actions, `edges` say what follows what, and `dispositionEntries` maps each outcome to the node its chain starts at. **Pick the narrowest endpoint that does the job.** | To | Call | | | --- | --- | --- | | See what fires per outcome | `GET .../workflow?view=summary` | Reads as plain text, no graph walking | | Add steps to an outcome | `POST .../outcomes/{outcome}/nodes` | Server derives node ids, edge ids, handles, layout | | Change a message, tag or setting | `PATCH .../workflow` | Merges; carries no graph, so it cannot damage one | | Remove one step | `DELETE .../nodes/{nodeId}` | Also re-links the chain around it | | Author or replace the whole graph | `PUT .../workflow` | Replaces everything you send | `PUT` is the only one that can re-wire, position nodes, build an `if`, save an unconfigured draft, or copy a whole workflow — and the only one that can overwrite a change someone else made after you read it. Use it when you are genuinely authoring the graph, and send `expectedVersion` when you do. For everything else the narrower endpoints are both easier and safer. - name: Contacts description: >- Find contacts and their calls, manage do-not-call status and identify internal contacts excluded from reporting. - name: In-call Capabilities description: >- Configure actions and instructions the agent uses during a live call: booking, transfers, lookups and custom skills. - name: Master agent description: >- Run a shared agent and campaign across linked projects; manage inheritance, local bindings, synchronization and rollout readiness. - name: Native Calendar description: >- The diary of a sub-account with no CRM: its bookable calendars, the free slots they offer, and the appointments on them. Availability is computed per request against live bookings and is never cached, because a cached slot is one somebody else has already taken. - name: Native Contacts description: >- The people a sub-account with no CRM calls, and the fields it keeps on them. This is the system of record for those contacts: there is nowhere else they exist. A sub-account with a CRM keeps its contacts there and every operation here answers 400 for it. - name: Phone Numbers description: >- Find and manage caller IDs, assign numbers to campaigns and understand connected Twilio numbers. - name: Projects description: >- Understand project ownership, inspect configuration and validate the local resources used by a campaign. - name: TFU Live description: >- Build one TFU Live agent with its Brain, Voice and equipped actions; connect it through shared Campaigns. - name: Voices description: >- Browse the voice catalogue and select a voice; configure speech and listening behavior in Agents. paths: /api/agent-builder/tools: get: tags: - In-call Capabilities summary: List available tools description: >- List both available **capabilities and platform tools** in one catalog. Appointment Booking, Live Transfer and Add a Tag are included here; they do not need a separate capability-list endpoint. Capabilities bundle an in-call action with its supported settings and related behavior. They share discovery with other tools, while their configuration has its own section in [Update campaign](/api-reference/campaigns/update-campaign). | Catalog entry | Kind | Update campaign field | | --- | --- | --- | | Appointment Booking | Capability | `capabilities.appointment_booking` | | Service Area Check | Tool | `tools.smart_service_area` | | Live Transfer | Capability | `capabilities.live_transfer` | | Add a Tag | Capability | `capabilities.add_tag` | | Check a Tag | Tool | `tools.check_tag` | Use [Get campaign](/api-reference/campaigns/get-campaign) to read installed `capabilities` and `tools`. This catalog lists what is available, not what is installed. A campaign may have zero capabilities. To install an entry, send `enabled: true` and its required settings in the corresponding Update campaign field. Omitted entries stay unchanged; `null` removes one. For stale-edit protection, optionally send `campaign.metadata.inventoryVersion` from Get campaign as `expectedVersion`. The Update campaign schema defines the supported configuration; individual skill endpoints remain available for targeted skill editing. The catalog `name` is a display label, such as "Live Transfer". It is not the `toolName` for Update a tool description. Use [Get agent](/api-reference/agents/get-agent) with `view=tools` and copy the exact installed `tools[].name`, such as `transfer_call`. A single catalog entry can create multiple installed tools. Custom instruction playbooks are described in the documentation. Required API key scope: `agents:read`. operationId: list-platform-tools responses: '200': description: Available platform tools and configuration fields. content: application/json: schema: $ref: '#/components/schemas/PlatformToolsResponse' example: success: true tools: - type: live_transfer name: Live Transfer description: Hand the caller to a person mid-call. repeatable: false fields: - name: transferNumber type: string required: true description: The number to transfer to, in E.164. '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' example: success: false error: UNAUTHORIZED message: Unauthorized '403': description: agents:read and builder access are required. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' example: success: false error: FORBIDDEN message: agents:read scope is required. '429': $ref: '#/components/responses/RateLimited' '500': description: The tool catalog could not be read. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' example: success: false error: INTERNAL_ERROR message: The tool catalog could not be read. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/agent-builder/tools \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: PlatformToolsResponse: type: object required: - success - tools properties: success: const: true tools: type: array description: >- Shared catalog of available capabilities and platform tools. This lists what can be installed, not what a particular agent has installed. Read Get campaign for installed capabilities and tools. items: type: object additionalProperties: false required: - type - name - description - repeatable - fields properties: type: type: string enum: - appointment_booking - smart_service_area - live_transfer - add_tag - check_tag description: >- Stable catalog key. appointment_booking, live_transfer and add_tag are capabilities: configure them under capabilities.{type} in Update campaign. smart_service_area and check_tag use tools.{type}. This is different from the installed execution tool name. name: type: string description: >- Human-readable catalog label, for example Live Transfer. For Update a tool description, use the installed tools[].name from Get agent with view=tools instead of this label. example: Live Transfer description: type: string repeatable: type: boolean fields: type: array items: $ref: '#/components/schemas/SkillsCapabilityField' AgentsErrorResponse: type: object additionalProperties: {} required: - success - error - message properties: success: type: boolean error: type: string description: Machine-readable error code. example: VALIDATION message: type: string description: Human-readable explanation safe to show to an operator. example: locationId is required. references: type: object additionalProperties: {} description: Structured conflict details. Present on delete conflicts. details: type: array description: Field-level validation details when available. items: type: object additionalProperties: false required: - field - message properties: field: type: - string - 'null' example: locationId message: type: string example: locationId is required. SkillsCapabilityField: type: object additionalProperties: false properties: name: type: string type: type: string enum: - string - boolean required: type: boolean description: type: string default: oneOf: - type: string - type: boolean required: - name - type - required - description ApiError: type: object description: Standard error envelope returned by the API. properties: success: type: boolean example: false error: type: string description: Short machine-readable error code. example: Unauthorized message: type: string description: Human-readable explanation of the error. example: Authentication required. required: - success - error responses: RateLimited: description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````