> ## 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 voices > List the curated voices available for agent configuration. Optionally filter by `accent`, `gender`, `region`, or `age`. Use the returned `voiceId` when updating an agent voice; call `GET /voices/{voiceId}` for the full detail record. Required API key scope: `voices:read`. ## OpenAPI ````yaml /openapi.yaml get /api/agent-builder/voices 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/voices: get: tags: - Voices summary: List voices description: >- List the curated voices available for agent configuration. Optionally filter by `accent`, `gender`, `region`, or `age`. Use the returned `voiceId` when updating an agent voice; call `GET /voices/{voiceId}` for the full detail record. Required API key scope: `voices:read`. operationId: list-voices parameters: - name: accent in: query required: false schema: type: string minLength: 1 description: >- Filter by accent label (case-insensitive), e.g. normal, british, southern. example: british - name: gender in: query required: false schema: type: string enum: - male - female description: Filter by voice gender (case-insensitive). example: female - name: region in: query required: false schema: type: string minLength: 1 description: Filter by regional grouping (case-insensitive), e.g. US, UK, AU, ES. example: US - name: age in: query required: false schema: type: string minLength: 1 description: >- Filter by age-band label (case-insensitive), e.g. young, middle_aged. example: middle_aged responses: '200': description: Voice catalogue. content: application/json: schema: $ref: '#/components/schemas/VoicesListVoicesResponse' examples: default: value: success: true voices: - voiceId: custom_voice_c5dae0d6c48a6ae36bac9bbcd0 voiceName: Kate (US) accent: normal gender: female age: middle_aged previewAudioUrl: >- /voice_previews/custom_voice_c5dae0d6c48a6ae36bac9bbcd0.wav total: 10 '400': description: Validation failed or the request is malformed. content: application/json: schema: $ref: '#/components/schemas/VoicesErrorResponse' examples: default: value: success: false error: BadRequest message: voiceId required '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/VoicesErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: Authenticated but not permitted to read the voice catalogue. content: application/json: schema: $ref: '#/components/schemas/VoicesErrorResponse' examples: default: value: success: false error: Forbidden message: You do not have access to voice catalogue endpoints. '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/VoicesErrorResponse' 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/VoicesErrorResponse' 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/voices \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: VoicesListVoicesResponse: type: object additionalProperties: false required: - success - voices - total properties: success: type: boolean voices: type: array items: $ref: '#/components/schemas/VoicesVoiceSummary' total: type: integer minimum: 0 description: Number of voices returned after filtering. example: 10 VoicesErrorResponse: type: object additionalProperties: {} required: - success - error - message properties: success: type: boolean error: type: string description: Machine-readable error code. example: NotFound message: type: string description: Human-readable explanation safe to show to an operator. example: Voice "custom_voice_missing" not found in catalogue. VoicesVoiceSummary: type: object additionalProperties: false required: - voiceId - voiceName - accent - gender - age - previewAudioUrl description: >- A voice as it appears in the catalogue list — enough to render and select it. properties: voiceId: type: string description: Stable id to send when selecting an agent voice. example: custom_voice_c5dae0d6c48a6ae36bac9bbcd0 voiceName: type: - string - 'null' description: Display name for the voice. example: Kate (US) accent: type: - string - 'null' description: Accent label used for filtering and display. example: normal gender: type: - string - 'null' enum: - male - female - null example: female age: type: - string - 'null' description: Age-band label used for picker metadata. example: middle_aged previewAudioUrl: type: - string - 'null' description: Relative URL for the voice preview audio file. example: /voice_previews/custom_voice_c5dae0d6c48a6ae36bac9bbcd0.wav securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````