List Voices
curl --request GET \
--url https://api.contactship.ai/v1/agents/voices \
--header 'x-api-key: <api-key>'import requests
url = "https://api.contactship.ai/v1/agents/voices"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.contactship.ai/v1/agents/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.contactship.ai/v1/agents/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 => [
"x-api-key: <api-key>"
],
]);
$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.contactship.ai/v1/agents/voices"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.contactship.ai/v1/agents/voices")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactship.ai/v1/agents/voices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"statusCode": 123,
"data": [
{}
],
"data[].id": "<string>",
"data[].name": "<string>",
"data[].language": "<string>",
"data[].accent": "<string>",
"data[].gender": "<string>",
"data[].age": "<string>",
"data[].description": "<string>",
"data[].preview_url": "<string>",
"data[].avatar_url": "<string>"
}Agentes
List Voices
Retrieve available voice records and IDs for voice-agent configuration.
GET
/
v1
/
agents
/
voices
List Voices
curl --request GET \
--url https://api.contactship.ai/v1/agents/voices \
--header 'x-api-key: <api-key>'import requests
url = "https://api.contactship.ai/v1/agents/voices"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.contactship.ai/v1/agents/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.contactship.ai/v1/agents/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 => [
"x-api-key: <api-key>"
],
]);
$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.contactship.ai/v1/agents/voices"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.contactship.ai/v1/agents/voices")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactship.ai/v1/agents/voices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"statusCode": 123,
"data": [
{}
],
"data[].id": "<string>",
"data[].name": "<string>",
"data[].language": "<string>",
"data[].accent": "<string>",
"data[].gender": "<string>",
"data[].age": "<string>",
"data[].description": "<string>",
"data[].preview_url": "<string>",
"data[].avatar_url": "<string>"
}Retrieve available voice records and IDs for voice-agent configuration.
Treat catalog values as current response data rather than hardcoding a sample voice ID. Preview metadata may be absent. A voice record’s ID is distinct from an agent ID. See Create agent.
Authentication
string
requerido
Organization API key. Keep it on your server or in a credential store.
Example
curl 'https://api.contactship.ai/v1/agents/voices' -H 'x-api-key: YOUR_API_KEY'
Response
number
200 on success.
object[]
Available voice records.
string
Voice ID to pass as
voice_id when creating or updating an agent.string
Display name.
string
Language metadata.
string
Accent metadata.
string
Gender metadata.
string
Age metadata.
string
Voice description.
string
Audio preview when available.
string
Avatar when available.
