Lister les voix disponibles
curl --request GET \
--url https://app.voicehire.io/api/v1/voices \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.voicehire.io/api/v1/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://app.voicehire.io/api/v1/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://app.voicehire.io/api/v1/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://app.voicehire.io/api/v1/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://app.voicehire.io/api/v1/voices")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voicehire.io/api/v1/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{
"default_voices": [
{
"agent_id": "agent_xxx",
"voice_name": "Myriam",
"language": "fr",
"description": "Voix professionnelle française"
},
{
"agent_id": "agent_yyy",
"voice_name": "Susan",
"language": "en",
"description": "Professional English voice"
}
],
"voice_clones": [
{
"voice_id": "clone_zzz",
"voice_clone_name": "Mon clone perso",
"language": "fr",
"preview_audio_url": "https://.../preview.mp3"
}
]
}
Compte
Lister les voix disponibles
Retourne les voix utilisables pour le paramètre override_agent_id lors de la création ou modification d’une campagne
GET
/
api
/
v1
/
voices
Lister les voix disponibles
curl --request GET \
--url https://app.voicehire.io/api/v1/voices \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.voicehire.io/api/v1/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://app.voicehire.io/api/v1/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://app.voicehire.io/api/v1/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://app.voicehire.io/api/v1/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://app.voicehire.io/api/v1/voices")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voicehire.io/api/v1/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{
"default_voices": [
{
"agent_id": "agent_xxx",
"voice_name": "Myriam",
"language": "fr",
"description": "Voix professionnelle française"
},
{
"agent_id": "agent_yyy",
"voice_name": "Susan",
"language": "en",
"description": "Professional English voice"
}
],
"voice_clones": [
{
"voice_id": "clone_zzz",
"voice_clone_name": "Mon clone perso",
"language": "fr",
"preview_audio_url": "https://.../preview.mp3"
}
]
}
Réponse
L’endpoint retourne deux groupes de voix :default_voices— voix VoiceHire par défaut, à utiliser via leuragent_idvoice_clones— clones vocaux de votre agence (statusready), à utiliser via leurvoice_id
{
"default_voices": [
{
"agent_id": "agent_xxx",
"voice_name": "Myriam",
"language": "fr",
"description": "Voix professionnelle française"
},
{
"agent_id": "agent_yyy",
"voice_name": "Susan",
"language": "en",
"description": "Professional English voice"
}
],
"voice_clones": [
{
"voice_id": "clone_zzz",
"voice_clone_name": "Mon clone perso",
"language": "fr",
"preview_audio_url": "https://.../preview.mp3"
}
]
}
array
required
array
required
Exemple de requête
curl -X GET https://app.voicehire.io/api/v1/voices \
-H "X-API-Key: vh_live_XXXXXXXXXXXXX"
import requests
response = requests.get(
"https://app.voicehire.io/api/v1/voices",
headers={"X-API-Key": "vh_live_XXXXXXXXXXXXX"}
)
voices = response.json()
print(f"{len(voices['default_voices'])} voix par défaut")
print(f"{len(voices['voice_clones'])} clone(s) d'agence")
# Exemple : choisir la première voix française
fr_voice = next((v for v in voices['default_voices'] if v['language'] == 'fr'), None)
if fr_voice:
print(f"Voix FR par défaut : {fr_voice['agent_id']}")
const axios = require('axios');
const response = await axios.get(
'https://app.voicehire.io/api/v1/voices',
{ headers: { 'X-API-Key': 'vh_live_XXXXXXXXXXXXX' } }
);
const { default_voices, voice_clones } = response.data;
console.log(`${default_voices.length} voix par défaut, ${voice_clones.length} clone(s)`);
Notes importantes
- Pour utiliser une voix dans une campagne, passez son
agent_id(voix par défaut) ou sonvoice_id(clone) dans le champoverride_agent_idlors de la création (POST /campaigns/create) ou modification (PATCH /campaigns/{campaign_id}). - Le drapeau
is_voice_cloneest déduit automatiquement côté backend, vous n’avez pas à le passer. - Les clones d’agence apparaissent uniquement si leur status est
ready(clonage terminé).
Codes d’erreur
| Code | code | Description |
|---|---|---|
| 401 | INVALID_API_KEY / MISSING_API_KEY | Clé API manquante ou invalide |
| 500 | INTERNAL_ERROR | Erreur interne lors de la récupération des voix |

