> ## 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. # Create test call > Place a real test call for an agent. The account must have billing enabled and available balance. Customer role: `agency_admin`. Required API key scope: `calls:write`. ## OpenAPI ````yaml /openapi.yaml post /api/agent-builder/agents/{id}/test-call 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/agents/{id}/test-call: post: tags: - Agents summary: Create test call description: >- Place a real test call for an agent. The account must have billing enabled and available balance. Customer role: `agency_admin`. Required API key scope: `calls:write`. operationId: create-test-call parameters: - name: id in: path required: true schema: type: string minLength: 1 description: Agent id returned by the Agents API. example: agent_2b7c9f4a requestBody: required: true description: Test call request. content: application/json: schema: $ref: '#/components/schemas/CallsTestCallRequest' examples: default: value: fromNumber: '+14155551234' toNumber: '+14155559876' contact: id: contact_123 name: Alex Morgan locationId: loc_9f7a123 campaignId: campaign_speed_to_lead_123 responses: '200': description: Test call started. content: application/json: schema: $ref: '#/components/schemas/CallsTestCallResponse' examples: default: value: success: true call: callId: call_123 callStatus: registered lifecycleId: life_2b7c9f4a '400': description: Validation failed or the request is malformed. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: VALIDATION message: A required value is missing. '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: Authenticated but not permitted to access the requested resource. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: Forbidden message: You do not have access to this project. '404': description: Resource not found or not visible to the caller. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: NotFound message: Call not found or access denied. '409': description: The requested action cannot be started in the current account state. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: CONFLICT message: Add a payment method before placing a test call. '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' 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/CallsErrorResponse' examples: default: value: success: false error: InternalError message: Unexpected server error. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request POST \ --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/test-call \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "fromNumber": "+14155551234", "toNumber": "+14155559876", "contact": { "id": "contact_123", "name": "Alex Morgan" }, "locationId": "loc_9f7a123", "campaignId": "campaign_speed_to_lead_123" }' components: schemas: CallsTestCallRequest: type: object additionalProperties: {} required: - fromNumber - toNumber properties: fromNumber: type: string description: >- Phone number that should place the test call. E.164 format is recommended. example: '+14155551234' toNumber: type: string description: Phone number to dial. E.164 format is recommended. example: '+14155559876' contact: $ref: '#/components/schemas/CallsTestCallContact' locationId: type: string example: loc_9f7a123 campaignId: type: string example: campaign_speed_to_lead_123 CallsTestCallResponse: type: object additionalProperties: false required: - success - call properties: success: type: boolean call: $ref: '#/components/schemas/CallsTestCallResult' CallsErrorResponse: 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: A required value is missing. CallsTestCallContact: type: object additionalProperties: false properties: id: type: string example: contact_123 name: type: string example: Alex Morgan CallsTestCallResult: type: object additionalProperties: false required: - callId - callStatus properties: callId: type: - string - 'null' example: call_123 callStatus: type: - string - 'null' example: registered lifecycleId: type: - string - 'null' example: life_2b7c9f4a securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````