> ## 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. # List agent types > List the three campaign types available when creating an agent, each with the starting capabilities you may pick from. This module intentionally excludes chat endpoints. Required API key scope: `agents:read`. ## OpenAPI ````yaml /openapi.yaml get /api/agent-builder/agent-types 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. - url: https://devapi.teamfollowup.ai description: Development API origin. Public API paths are under /api. security: [] tags: - name: Agents description: Manage voice agents, campaigns, workflows, and outcomes. - name: Analytics description: >- Minimal, non-billing performance summary: volume, conversion, and pickup metrics. - name: Calls description: Review calls, test runs, and execution history. - name: Campaign Workflows description: >- 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/digest` | 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: Contact list, filters, contact call history, and do-not-call actions. - name: GHL description: CRM variables and contact helpers used by agent and campaign setup flows. - name: Phone Numbers description: >- Caller ID pool, number search, assignment, movement, and release endpoints. - name: Power Dialer description: >- Power Dialer queue, lead cadence, callback, parked lead, and campaign schedule endpoints. - name: Projects description: >- Project management endpoints: list, update, disconnect, configure project campaigns, and validate setup. - name: Skills and Tools description: Manage reusable agent behaviors and in-call tool descriptions. - name: Voices description: Voice catalogue endpoints for choosing the voice used by an agent. paths: /api/agent-builder/agent-types: get: tags: - Agents summary: List agent types description: >- List the three campaign types available when creating an agent, each with the starting capabilities you may pick from. This module intentionally excludes chat endpoints. Required API key scope: `agents:read`. operationId: get-agent-builder-agent-types responses: '200': description: Campaign types and their starting capabilities. content: application/json: schema: $ref: '#/components/schemas/AgentsListAgentTypesResponse' examples: default: value: success: true agentTypes: - id: outreach agentType: outreach label: Outreach description: Call a lead after they enter a workflow or pipeline. templates: - id: appointment_booking label: Appointment Booking description: >- Find real availability and book the time the lead accepts. version: 1 - id: live_transfer label: Live Transfer description: Qualify the lead, then connect them to a person. version: 1 - id: add_tag label: Add Tag description: >- Apply a CRM tag during the call to trigger the next automation. version: 1 - id: inbound agentType: inbound label: Inbound description: >- Answer incoming calls and help the caller in real time. templateId: inbound_receptionist version: 1 templates: - id: appointment_booking label: Appointment Booking description: >- Find real availability and book the time the lead accepts. version: 1 - id: live_transfer label: Live Transfer description: Qualify the lead, then connect them to a person. version: 1 - id: add_tag label: Add Tag description: >- Apply a CRM tag during the call to trigger the next automation. version: 1 - id: appointment agentType: appointment label: Reminder description: >- Remind, confirm, or reschedule someone who already has an appointment. templateId: appointment_confirmation version: 1 '400': description: Validation failed or the request body is malformed. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: VALIDATION message: Invalid request. '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: >- Authenticated but missing the required `agents:read` scope or tenant access. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: FORBIDDEN message: No access to agent "agent_1ffdb9717444d0e77346838911". insufficientScope: value: success: false error: InsufficientScope message: This API key does not have the required scope. requiredScope: agents:read '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: TooManyRequests message: Too many requests, please try again later. '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: InternalError message: Unexpected server error. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/agent-builder/agent-types \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: AgentsListAgentTypesResponse: type: object additionalProperties: false required: - success - agentTypes properties: success: type: boolean agentTypes: type: array items: $ref: '#/components/schemas/AgentsAgentType' 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. AgentsAgentType: type: object additionalProperties: {} required: - id - agentType - label - description description: >- One of the three campaign types. Outreach and Inbound also list the starting capabilities you may pick from; Reminder resolves to a single fixed template. properties: id: type: string enum: - outreach - inbound - appointment description: Stable campaign type id. Same value as `agentType`. example: outreach agentType: type: string enum: - outreach - inbound - appointment description: Campaign type id accepted by Create agent. example: outreach label: type: string example: Outreach description: type: string example: Call a lead after they enter a workflow or pipeline. templates: type: array description: >- Starting capabilities available for this campaign type. Present on Outreach and Inbound; pass one or more of these ids as `capabilityIds` on Create agent. Absent on Reminder, which always starts with Appointment Booking. items: type: object additionalProperties: {} required: - id - label properties: id: type: string enum: - appointment_booking - live_transfer - add_tag example: live_transfer label: type: string example: Live Transfer description: type: string example: Qualify the lead, then connect them to a person. version: type: integer example: 1 templateId: type: string enum: - appointment_confirmation - appointment_booking - live_transfer - live_transfer_and_tag - live_transfer_and_booking - add_tag - inbound_receptionist description: >- Legacy V2 template this campaign type clones from. Emitted for Inbound and Reminder, whose base template is fixed. Informational — Create agent derives it. example: inbound_receptionist version: type: integer example: 1 securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````