Skip to main content
POST
Créez un aperçu temporaire de voix clonée à partir de 1 à 3 fichiers audio envoyés qui vous appartiennent, avec une autorisation explicite. Le quota d’essai de clonage de l’application s’applique. Enregistrez l’aperçu choisi avant son expiration pour le conserver.

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: voices: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: 80.
array
requis
Liste de valeurs. Consultez le schéma d’entrée complet pour connaître la structure de ses éléments.Nombre minimal d’éléments: 1. Nombre maximal d’éléments: 3.
boolean
requis
Confirmez que vous avez l’autorisation de cloner la voix de la personne présente dans chaque échantillon.Valeur requise: true.
boolean
Valeur booléenne.Valeur par défaut: false.
string
Valeur textuelle.Longueur maximale: 35. Motif: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
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. Tous les aperçus de voix actifs non enregistrés et les quotas de création actualisés, y compris le nouveau candidat de clonage.

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.
  • Envoyez 1–3 échantillons audio appartenant au compte et utilisez leurs valeurs fileKey finalisées. Les formats d’échantillon pris en charge sont MP3, WAV, M4A, OGG et Opus ; chaque fichier doit être non vide et ne pas dépasser 20 MiB (20,971,520 octets). Les URL distantes et les envois d’autres comptes sont refusés.
  • Les échantillons doivent totaliser au moins 10 secondes et au plus 120 secondes d’audio lisible. trimToMaxDuration vaut false par défaut ; définissez-le sur true pour raccourcir proportionnellement les échantillons totalisant plus de 120 secondes.
  • hasPermission doit être le booléen JSON true, confirmant l’autorisation pour chaque échantillon. Une chaîne telle que “true” est rejetée.
  • name doit contenir 1–80 caractères après suppression des espaces en début et en fin. Le champ facultatif language accepte un code de 2–3 lettres avec des sous-étiquettes facultatives, pour un maximum de 35 caractères.
  • Utilise l’unique essai d’aperçu de clonage à vie du compte. La création de cet aperçu n’enregistre pas de voix TTS réutilisable et n’occupe pas d’emplacement de voix enregistrée.
  • Le nouveau candidat de clonage a kind: clone et est conservé pendant 24 heures. Sa lecture est limitée à environ 10 secondes.
  • La réponse inclut tous les aperçus actifs non enregistrés. Utilisez voices_preview_get pour actualiser la lecture, puis voices_save_preview pour conserver le candidat choisi avec un forfait payant.
  • language sélectionne le script d’aperçu lorsqu’un script pris en charge existe ; ce champ ne demande pas de traduire l’échantillon envoyé.
  • 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