List voices

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/agent-builder/voices \
  --header 'Authorization: Bearer YOUR_API_KEY'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.teamfollowup.ai/api/agent-builder/voices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.teamfollowup.ai/api/agent-builder/voices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.teamfollowup.ai/api/agent-builder/voices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/voices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "success": false,
  "error": "BadRequest",
  "message": "voiceId required"
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Forbidden",
  "message": "You do not have access to voice catalogue endpoints."
}

{
  "success": false,
  "error": "TooManyRequests",
  "message": "Too many requests, please try again later."
}

{
  "success": false,
  "error": "InternalError",
  "message": "Unexpected server error."
}

GET

api

agent-builder

voices

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/agent-builder/voices \
  --header 'Authorization: Bearer YOUR_API_KEY'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.teamfollowup.ai/api/agent-builder/voices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.teamfollowup.ai/api/agent-builder/voices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.teamfollowup.ai/api/agent-builder/voices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/voices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "success": false,
  "error": "BadRequest",
  "message": "voiceId required"
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Forbidden",
  "message": "You do not have access to voice catalogue endpoints."
}

{
  "success": false,
  "error": "TooManyRequests",
  "message": "Too many requests, please try again later."
}

{
  "success": false,
  "error": "InternalError",
  "message": "Unexpected server error."
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

accent

string

Filter by accent label (case-insensitive), e.g. normal, british, southern.

Minimum string length: 1

gender

enum<string>

Filter by voice gender (case-insensitive).

Available options:

male,

female

region

string

Filter by regional grouping (case-insensitive), e.g. US, UK, AU, ES.

Minimum string length: 1

age

string

Filter by age-band label (case-insensitive), e.g. young, middle_aged.

Minimum string length: 1

Response

Voice catalogue.

success

boolean

required

voices

object[]

required

Show child attributes

total

integer

required

Number of voices returned after filtering.

Required range: x >= 0

Example:

10

Agents

Skills & Tools

Campaigns

Campaign Workflows

Calls

Analytics

Projects

Power Dialer

Contacts

Phone Numbers

Voices

GHL

Authorizations

Query Parameters

Response