> ## 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. # Start a web test session > Start a browser conversation with the agent, using its own prompt and begin message untouched. The response carries the `accessToken` that opens the session and the `callId` the resulting call record will carry. There is no lead on a web session, so lead-specific prompt variables are empty by design. Web minutes bill like phone minutes: the same billing gates as a test call apply, and a refused gate answers 409 with the reason in `message`. A 502 means the voice provider refused to start the session; nothing is wrong with the agent or its setup. Required API key scope: `calls:write`. ## OpenAPI ````yaml /openapi.yaml post /api/agent-builder/agents/{id}/web-version/session 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: Manage voice agents, campaigns, workflows, and outcomes. - name: Analytics description: >- Minimal, non-billing performance summary: volume, conversion, and pickup metrics. - name: Billing description: >- Billing for your own agency: balance, spend, transaction history, invoices and sub-account wallets; auto-recharge, rebilling, Credit Guard and Stripe customers; and, with the billing:charge scope, purchases and charges. - 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: Split Testing description: >- Split live campaign traffic across agent variants and shift the weights between them. - name: Voices description: Voice catalogue endpoints for choosing the voice used by an agent. paths: /api/agent-builder/agents/{id}/web-version/session: post: tags: - Agents summary: Start a web test session description: >- Start a browser conversation with the agent, using its own prompt and begin message untouched. The response carries the `accessToken` that opens the session and the `callId` the resulting call record will carry. There is no lead on a web session, so lead-specific prompt variables are empty by design. Web minutes bill like phone minutes: the same billing gates as a test call apply, and a refused gate answers 409 with the reason in `message`. A 502 means the voice provider refused to start the session; nothing is wrong with the agent or its setup. Required API key scope: `calls:write`. operationId: post-agent-builder-agents-by-id-web-version-session parameters: - name: id in: path required: true schema: type: string minLength: 1 description: Agent id. example: agent_1ffdb9717444d0e77346838911 responses: '200': description: The session credentials. content: application/json: schema: $ref: '#/components/schemas/AgentsWebSessionResponse' examples: default: value: success: true data: accessToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.web-session-token callId: call_3f9c2a1b7d8e4f5a6b7c8d9e agentName: Roofing Follow Up '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: id path parameter is required. '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 `calls:write` 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: calls:write '404': description: Agent or related project not found. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: NOT_FOUND message: Agent "agent_1ffdb9717444d0e77346838911" not found. '409': description: Request conflicts with current agent state. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: CONFLICT message: >- Add a payment method to your agency wallet before using the web agent. '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. '502': description: The voice provider refused to start the session. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: VoiceProviderUnavailable message: >- Your voice provider is unavailable right now. Try again shortly — nothing is wrong with this agent or its setup. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request POST \ --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/web-version/session \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: AgentsWebSessionResponse: type: object additionalProperties: false required: - success - data properties: success: type: boolean data: $ref: '#/components/schemas/AgentsWebSession' 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. AgentsWebSession: type: object additionalProperties: {} required: - accessToken - agentName properties: accessToken: type: string description: >- Short-lived token that opens the browser session with the voice provider. Treat it as a secret for the life of the session. example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.web-session-token callId: type: - string - 'null' description: >- The voice platform call id the session is recorded under. Fetch the record afterwards with `GET /api/call-history/by-call-id/{callId}`. Null when the provider did not return one. example: call_3f9c2a1b7d8e4f5a6b7c8d9e agentName: type: string description: Display name of the agent, for the session UI. example: Roofing Follow Up securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````