Skip to main content
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>'
{
  "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 leur agent_id
  • voice_clones — clones vocaux de votre agence (status ready), à utiliser via leur voice_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"
    }
  ]
}
​
default_voices
array
required
Voix par défaut VoiceHire (toutes agences).
​
voice_clones
array
required
Clones vocaux de votre agence (status ready uniquement).

​
Exemple de requête

curl -X GET https://app.voicehire.io/api/v1/voices \
  -H "X-API-Key: vh_live_XXXXXXXXXXXXX"

​
Notes importantes

  • Pour utiliser une voix dans une campagne, passez son agent_id (voix par défaut) ou son voice_id (clone) dans le champ override_agent_id lors de la création (POST /campaigns/create) ou modification (PATCH /campaigns/{campaign_id}).
  • Le drapeau is_voice_clone est 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

CodecodeDescription
401INVALID_API_KEY / MISSING_API_KEYClé API manquante ou invalide
500INTERNAL_ERRORErreur interne lors de la récupération des voix

Authorizations

​
X-API-Key
string
header
required

Clé API au format vh_live_XXXXX

Response

Liste des voix

​
default_voices
object[]

Voix par défaut VoiceHire — à utiliser via agent_id

​
voice_clones
object[]

Clones de l'agence — à utiliser via voice_id