aethexDocs
Tableau de bord

Référence API

API Voix

Parcourez le catalogue de voix TTS et écoutez des aperçus courts.Accès en lecture. voices:read liste le catalogue et recherche des voix individuelles.Aperçu. tts:use alimente POST /voices/preview, qui facture par caractère au même tarif que POST /tts.

URL de base
https://api.aethexai.com/api/v1
Endpoints
5
Portées
voices:readtts:use
GET/voices

Parcourir toutes les voix disponibles pour votre compte.

Lister les voix

Liste toutes les voix utilisables : le catalogue global plus les voix privées de votre compte. Filtrez par language, supports_dialect_style, tag ou country. Les résultats sont en ordre stable (plus récent en premier) ; continuez à paginer jusqu'à recevoir moins de lignes que limit.Les IDs de voix sont des UUID dans l'API moderne. Le champ id de chaque objet de réponse est un UUID — copiez-le directement dans vos champs voice_id. La valeur sentinelle "default" n'est acceptée que sur l'endpoint de synthèse TTS (POST /tts) ; POST /voices/preview et la création/mise à jour d'agent exigent un UUID de voix réel (ou un voice_key hérité) issu de cette liste, sinon ils renvoient une erreur 404/422. Les agents existants créés avec des IDs en format slug continuent de fonctionner sans migration. Le nouveau code devrait utiliser un UUID depuis cette liste.

Chemin & Requête

6
  • languagestringoptionnel

    N'afficher que les voix dans cette langue. Actuellement english ou french. Une valeur inconnue retourne une liste vide.

  • supports_dialect_stylebooleanoptionnel

    N'afficher que les voix qui respectent le paramètre dialect_style de votre agent (formal / mixed / local).

  • tagstringoptionnel

    N'afficher que les voix portant ce token. Sensible à la casse ; la valeur doit provenir de GET /voices/tag-vocabulary (n'importe quel token de n'importe quelle catégorie). Une valeur vide ou composée uniquement d'espaces est traitée comme aucun filtre. Un token inconnu retourne une liste vide plutôt qu'un 422.

  • countrystringoptionnel

    N'afficher que les voix de ce pays, sous forme de code ISO 3166-1 alpha-2 (NG, FR, US, ...). Insensible à la casse. Une valeur vide ou composée uniquement d'espaces est traitée comme aucun filtre et retourne toutes les voix du catalogue. Appelez GET /voices/countries pour la liste complète. Un code inconnu retourne une liste vide plutôt qu'un 422.

  • limitintegeroptionnel

    Nombre de voix à retourner par page. Par défaut 100, plage 0–500.

  • offsetintegeroptionnel

    Nombre de voix à ignorer avant cette page. Par défaut 0.

Erreurs

1
422Pagination invalide

limit est hors de 0–500 ou offset est négatif.

Gardez limit entre 0 et 500 et utilisez un offset non négatif.

GET/voices/countries

Énumérer les codes `country` supportés pour le filtre `?country=`.

Lister les pays

Retourne l'ensemble fermé des codes ISO 3166-1 alpha-2 utilisés par le catalogue de voix, avec leurs noms d'affichage. Trié par code. Utilisez cet endpoint pour alimenter une liste déroulante de pays dans votre application plutôt que de coder en dur une liste. L'ensemble couvre tous les pays d'Europe, des Amériques, d'Afrique et du Moyen-Orient (149 codes) ; l'Asie hors Moyen-Orient et l'Océanie pourront être ajoutées dans de futures versions.

GET/voices/tag-vocabulary

Énumérer l'ensemble fermé des tokens `tag` acceptés par le catalogue.

Lister le vocabulaire de tags

Retourne le vocabulaire canonique des tags de voix, groupés en quatre catégories destinées à l'interface : tone, voice_texture, delivery_style et business_persona. Le regroupement est purement une commodité UI — le stockage sous-jacent est une liste plate et n'importe quel token de n'importe quelle catégorie est une valeur de filtre valide pour le filtre ?tag= de GET /voices. Utilisez cet endpoint pour alimenter un sélecteur de tags dans votre tableau de bord ou pour valider côté client les tags saisis par l'utilisateur avant de l'envoyer comme filtre ?tag= sur GET /voices. Le vocabulaire est une configuration statique qui change rarement — il peut être mis en cache pour la durée d'une page.

GET/voices/:voice_id

Rechercher une voix par son ID.

Obtenir une voix

Retourne une seule voix par ID. Une voix privée avec le même ID qu'une voix globale prend priorité.

Chemin & Requête

1
  • voice_idstringrequis

    L'identifiant de la voix — un UUID (préféré), depuis le champ id retourné par GET /voices ; les anciens slugs voice_key sont toujours acceptés.

Erreurs

1
404Voix introuvable

Aucune voix avec cet ID n'est disponible sur votre compte.

Listez à nouveau avec GET /voices pour choisir un ID actuellement disponible.

POST/voices/preview

Écoutez une voix. Retourne un court fichier WAV.

Aperçu de voix

Synthétise un court échantillon audio afin que vous puissiez entendre le rendu d'une voix avant de la connecter à un agent. Retourne un fichier audio/wav complet. Toute voix de votre compte est utilisable ; sélectionnez un id depuis GET /voices.Ce n'est pas un endpoint TTS gratuit. L'aperçu limite text à 300 caractères et est facturé au même tarif par caractère que POST /tts. Pour des textes plus longs ou de l'audio en production, utilisez POST /tts.

Corps de la requête

2
  • voice_idstringrequis

    La voix à entendre. Utilisez n'importe quel id de GET /voices (un UUID ou un voice_key hérité). La valeur sentinelle "default" n'est pas acceptée sur cet endpoint.

  • textstringoptionnel

    Ce que la voix doit dire. 1–300 caractères. Par défaut "Hello, this is a sample of my voice."

Erreurs

3
404Voix introuvable

Le voice_id n'est pas disponible sur votre compte.

Choisissez un id de voix dans GET /voices (un UUID ou un voice_key hérité) ; la sentinelle "default" n'est pas valide ici.

422Erreur de validation

text est vide ou dépasse 300 caractères, ou voice_id est manquant.

Gardez text entre 1 et 300 caractères. Pour un audio plus long, utilisez POST /tts.

429Limite de débit atteinte

Vous avez atteint la limite de débit de votre clé API.

Respectez l'en-tête Retry-After et ralentissez.