Skip to main content
POST
Créez de la parole à partir de texte avec une voix du catalogue ou une voix personnalisée qui vous appartient. Les mêmes crédits de caractères et limites de forfait que dans l’application s’appliquent. Renvoie un identifiant d’historique et une URL temporaire de téléchargement audio. Réutilisez requestId pour éviter une seconde génération.

Authentification et autorisations

string
requis
Envoyez une clé API VoiceCheap dans cet en-tête. Authorization: Bearer avec la même clé API est également accepté. Les jetons d’accès OAuth sont acceptés uniquement par MCP, pas par cet endpoint REST.
Autorisations requises: tts:write. Un abonnement payant actif est requis. Les autorisations ne modifient ni les rôles dans l’équipe, ni la propriété des ressources, ni les crédits média, ni les limites du forfait.

Paramètres

string
Facultatif au niveau du transport : le serveur injecte un identifiant avant la validation si ce champ est omis. Fournissez votre propre UUID v4 stable pour récupérer le résultat en toute sécurité si la réponse est perdue.Format: “uuid”. Motif: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
string
requis
Valeur textuelle.Longueur minimale: 1. Longueur maximale: 128000.
string
requis
Identifiant de sélection de voix issu de voices_list, y compris les identifiants clone: des voix personnalisées enregistrées.Longueur minimale: 1. Longueur maximale: 255.
string
Valeur textuelle.Valeurs acceptées: “text”, “pdf”. Valeur par défaut: “text”.
string
Valeur textuelle.Valeurs acceptées: “default”, “cheerful”, “calm”, “narrator”, “dramatic”, “whisper”, “energetic”. Valeur par défaut: “default”.
string
Valeur textuelle.Longueur maximale: 300.
number
Valeur numérique.Minimum: 0.5. Maximum: 2. Valeur par défaut: 1.
string
Valeur textuelle.Longueur maximale: 255.
Le JSON Schema ci-dessous conserve les noms de champs exacts, les types imbriqués, les valeurs par défaut, les limites et les valeurs acceptées exposés par la découverte. Les règles supplémentaires entre champs figurent dans les notes de l’opération.

Idempotence

Utilisez un UUID v4 dans requestId ou dans l’en-tête HTTP Idempotency-Key pour chaque mutation. Après une erreur réseau, réutilisez le même identifiant avec des arguments identiques. Si les deux sont fournis, ils doivent correspondre. Rejouer une requête enregistrée ne répète pas l’opération et ne décompte pas un nouvel appel mensuel. Les requêtes en échec ou interrompues ne sont pas relancées automatiquement. Toute mutation peut renvoyer HTTP 202 lorsqu’une nouvelle tentative retrouve la même requête encore en cours, même si sa première exécution est habituellement synchrone. Si l’exécution est terminée mais que resultStored vaut false, une nouvelle tentative renvoie HTTP 200 avec l’état de la requête enregistrée, au lieu du résultat d’origine. Récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement de son domaine.

Exemples de requêtes

Remplacez les exemples d’identifiants de ressources et de clés média par des valeurs renvoyées pour votre compte. Conservez le même identifiant de requête lorsque vous réessayez la même mutation.

Réponse

Cette opération renvoie HTTP 202 pendant son exécution. Conservez requestId et interrogez action_request_get avec cet identifiant et le nom de l’opération d’origine. Les états de suivi sont running, completed, failed et interrupted. Un résultat terminé peut renvoyer vers une tâche média distincte ; poursuivez avec l’action de statut ou de résultat propre à l’opération. Métadonnées de la génération de parole terminée et URL temporaire de téléchargement du MP3. Le gestionnaire ne renvoie pas d’octets audio.

Champs du résultat

Récupérer et suivre cette requête

Utilisez le même identifiant, même après une perte de connexion. Si resultStored vaut false, récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement correspondante. Ne lancez jamais une seconde génération uniquement pour vérifier l’avancement.
HTTP 200

Notes de l’opération

  • Utilisez un requestId UUID v4 pour cette mutation et réutilisez-le avec des arguments identiques lors des nouvelles tentatives. Les actions longues renvoient d’abord une requête running ; cet exemple est le résultat terminé du gestionnaire disponible via action_request_get.
  • Choisissez voice dans voices_list. Les ID de voix de doublage de dubbing_voices_list appartiennent à une bibliothèque distincte.
  • Les espaces en début et en fin du texte sont supprimés. Le schéma accepte au plus 128,000 caractères ; les offres Beginner et Starter actuelles autorisent 64,000 caractères par génération, contre 128,000 pour Creator et les offres supérieures. L’offre actuelle et les crédits de caractères TTS disponibles sont vérifiés de nouveau avant la génération.
  • inputType vaut text par défaut et peut être text ou pdf. Même avec pdf, fournissez le texte extrait dans text ; cette action n’accepte pas l’envoi d’un PDF ni une URL de PDF.
  • instructionPreset vaut default par défaut et accepte default, cheerful, calm, narrator, dramatic, whisper et energetic. instructions est facultatif et limité à 300 caractères après suppression des espaces en début et en fin. speed vaut 1 par défaut et varie de 0.5 à 2.
  • sourceFileName est une métadonnée facultative, limitée à 255 caractères après suppression des espaces en début et en fin, qui détermine le nom du fichier téléchargé.
  • Une requête répétée réussie restitue l’audio enregistré sans le générer ni le facturer à nouveau. Les URL sont temporaires ; utilisez tts_download pour obtenir un nouveau téléchargement.
  • L’historique de synthèse vocale et les voix personnalisées appartiennent au compte authentifié. La facturation d’équipe ne donne pas accès à la synthèse vocale ni aux voix d’un autre membre.

Utilisation

Chaque invocation réussie consomme un appel du quota mensuel API/MCP. Les crédits média et les quotas de génération propres à l’opération s’appliquent également.

Erreurs