> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Enregistrer un aperçu vocal

> Enregistrez un aperçu de voix clonée ou conçue non expiré qui vous appartient pour en faire une voix réutilisable. Les enregistrements répétés du même aperçu réutilisent la voix déjà enregistrée.

Enregistrez un aperçu de voix clonée ou conçue non expiré qui vous appartient pour en faire une voix réutilisable. Les enregistrements répétés du même aperçu réutilisent la voix déjà enregistrée.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/voices_save_preview
```

## Authentification et autorisations

<ParamField header="x-api-key" type="string" required>
  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.
</ParamField>

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

<ParamField body="requestId" type="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}$`.
</ParamField>

<ParamField body="previewId" type="string" required>
  Valeur textuelle.

  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})$`.
</ParamField>

<ParamField body="name" type="string" required>
  Valeur textuelle.

  Longueur minimale: 1. Longueur maximale: 80.
</ParamField>

<Accordion title="Schéma d’entrée complet">
  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.

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "requestId": {
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
        "type": "string",
        "format": "uuid",
        "pattern": "^[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}$"
      },
      "previewId": {
        "type": "string",
        "format": "uuid",
        "pattern": "^([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})$"
      },
      "name": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      }
    },
    "required": ["previewId", "name"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 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.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_save_preview' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","previewId":"44444444-4444-4444-8444-444444444444","name":"Studio narrator"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
    previewId: '44444444-4444-4444-8444-444444444444',
    name: 'Studio narrator',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_save_preview', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.VOICECHEAP_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(input),
  });
  const body = await response.json();
  if (!response.ok) throw new Error(body.code + ': ' + body.message);
  console.log(body);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/voices_save_preview",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "previewId": "44444444-4444-4444-8444-444444444444", "name": "Studio narrator"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## 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.

Voix TTS réutilisable enregistrée, quota actualisé d’emplacements enregistrés, aperçus actifs non enregistrés restants et quotas de création restants.

<ResponseExample>
  ```json HTTP 202 theme={null}
  {
    "data": {
      "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
      "status": "running",
      "pollAction": "action_request_get",
      "pollAfterSeconds": 5
    },
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
  }
  ```

  ```json HTTP 200 theme={null}
  {
    "data": {
      "voicePreviews": [],
      "creationUsage": {
        "cloneTrial": {
          "limit": 1,
          "used": 1,
          "remaining": 0
        },
        "design": {
          "limit": 5,
          "used": 0,
          "remaining": 5,
          "resetsAt": 1792195200000
        },
        "previewExpiresAfterHours": 24
      },
      "voice": {
        "accent": "original",
        "id": "clone:44444444-4444-4444-8444-444444444444",
        "name": "Studio narrator",
        "previewUrl": "https://files.example.com/saved-narrator.mp3",
        "source": "clone"
      },
      "cloneUsage": {
        "canClone": true,
        "limit": 10,
        "remaining": 9,
        "used": 1
      }
    },
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
      "operation": "voices_save_preview",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
      "operation": "voices_save_preview",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
  }
  ```
</ResponseExample>

## Champs du résultat

| Champ | Description |
| - | - |
| `data.voicePreviews` | Tous les aperçus actuellement actifs et non enregistrés de ce compte, y compris les candidats issus de requêtes antérieures. |
| `data.voicePreviews[].id` | UUID v4 de l’aperçu utilisé par voices\_preview\_get et voices\_save\_preview. |
| `data.voicePreviews[].kind` | clone ou design. |
| `data.voicePreviews[].name` | Nom d’affichage de l’aperçu ; les candidats de voix conçues ajoutent un numéro au nom demandé. |
| `data.voicePreviews[].previewUrl` | URL audio temporaire permettant la lecture. Demandez une nouvelle URL avec voices\_preview\_get tant que l’aperçu reste actif. |
| `data.voicePreviews[].expiresAt` | Expiration de l’aperçu sous forme d’horodatage Unix en millisecondes. |
| `data.voicePreviews[].durationSeconds` | Durée de l’aperçu audio en secondes. |
| `data.creationUsage.cloneTrial` | Quota d’essai d’aperçu de clonage valable à vie, avec limit, used et remaining. |
| `data.creationUsage.design` | Quota quotidien de conception de voix avec limit, used, remaining et resetsAt en millisecondes Unix. |
| `data.creationUsage.previewExpiresAfterHours` | Durée de vie d’un aperçu non enregistré, en heures, actuellement 24. |
| `data.voice.id` | Identifiant de sélection de synthèse vocale réutilisable clone:\<UUID>. Utilisez la valeur entière pour tts\_generate et uniquement l’UUID pour voices\_delete. |
| `data.voice.name` | Nom d’affichage de la voix enregistrée. |
| `data.voice.accent` | Les voix personnalisées enregistrées utilisent original. |
| `data.voice.source` | Les voix personnalisées enregistrées utilisent clone. |
| `data.voice.previewUrl` | URL temporaire d’aperçu audio de la voix enregistrée. |
| `data.cloneUsage.canClone` | Indique si le forfait actuel permet l’enregistrement de voix de synthèse vocale personnalisées ; consultez remaining pour connaître les emplacements disponibles. |
| `data.cloneUsage.limit` | Nombre maximal d’emplacements de voix TTS personnalisées enregistrées autorisé par l’offre. |
| `data.cloneUsage.used` | Emplacements de voix de synthèse vocale occupés, y compris les créations réservées. |
| `data.cloneUsage.remaining` | Emplacements disponibles pour les voix TTS enregistrées. |

## 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.

```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"voices_save_preview"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "voices_save_preview",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "voicePreviews": [],
      "creationUsage": {
        "cloneTrial": {
          "limit": 1,
          "used": 1,
          "remaining": 0
        },
        "design": {
          "limit": 5,
          "used": 0,
          "remaining": 5,
          "resetsAt": 1792195200000
        },
        "previewExpiresAfterHours": 24
      },
      "voice": {
        "accent": "original",
        "id": "clone:44444444-4444-4444-8444-444444444444",
        "name": "Studio narrator",
        "previewUrl": "https://files.example.com/saved-narrator.mp3",
        "source": "clone"
      },
      "cloneUsage": {
        "canClone": true,
        "limit": 10,
        "remaining": 9,
        "used": 1
      }
    }
  }
}
```

## 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.
* previewId est l’UUID du candidat appartenant au compte renvoyé par voices\_preview\_clone ou voices\_design. name contient 1–80 caractères après suppression des espaces en début et en fin.
* L’enregistrement nécessite une offre payante, un emplacement disponible pour une voix TTS enregistrée et un aperçu prêt non expiré. Cette action fonctionne pour les candidats clonés et conçus.
* L’ID de sélection réutilisable est clone:\<previewId>. Un candidat enregistré disparaît de voicePreviews ; voices\_list l’inclut parmi les voix enregistrées.
* Les enregistrements répétés d’un même candidat déjà enregistré réutilisent la voix enregistrée. Le nom enregistré d’origine est conservé lors d’un nouvel enregistrement.
* voice peut être omis si la voix enregistrée est absente de la liste actualisée des voix. Récupérez les voix enregistrées actuelles avec voices\_list.
* 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

| Statut HTTP | Code | Signification ou solution |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Des identifiants ont été fournis dans un paramètre de requête access\_token ou api\_key. Envoyez les identifiants dans les en-têtes. |
| 400 | `IDEMPOTENCY_CONFLICT` | L’en-tête Idempotency-Key et le champ requestId du corps doivent correspondre. |
| 400 | `INVALID_REQUEST_ID` | Fournissez un UUID v4 dans requestId ou Idempotency-Key. |
| 400 | `VALIDATION_ERROR` | L’entrée ne correspond pas au schéma de l’action ; examinez details pour connaître les erreurs de champs. |
| 401 | `API_KEY_EXPIRED` | La clé API a expiré. |
| 401 | `INVALID_API_KEY` | Fournissez une clé API valide et non expirée. |
| 401 | `INVALID_CREDENTIAL` | L’en-tête Authorization est mal formé ou entre en conflit avec x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Aucun identifiant d’authentification utilisable n’a été fourni dans les en-têtes, ou il dépassait 4096 caractères. |
| 401 | `USER_NOT_FOUND` | Le compte associé à l’identifiant d’accès n’existe plus. |
| 403 | `ACCOUNT_UNAVAILABLE` | Le compte à l’origine de l’action ou le compte de facturation est indisponible ou en cours de suppression. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | L’utilisateur associé aux identifiants d’authentification appartient à plusieurs équipes, ce qui rend le contexte de facturation ambigu. |
| 403 | `INSUFFICIENT_SCOPE` | Accordez toutes les autorisations requises ou choisissez d’autres identifiants d’accès. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Les limites d’intégration du compte n’ont pas pu être vérifiées. |
| 403 | `SUBSCRIPTION_REQUIRED` | Utilisez un abonnement payant actif. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Le compte du propriétaire effectif de l’équipe est introuvable. |
| 403 | `VOICE_CLONING_REQUIRES_PAID_PLAN` | Le forfait actuel ne permet pas d’enregistrer et de réutiliser des voix TTS personnalisées. |
| 404 | `USER_NOT_FOUND` | Le compte authentifié n’existe plus. |
| 404 | `VOICE_PREVIEW_NOT_FOUND` | L’aperçu est absent ou appartient à un autre compte. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Ce compte a déjà 10 actions d’intégration en cours. Suivez une requête existante avant d’en démarrer une autre. |
| 409 | `IDEMPOTENCY_CONFLICT` | Réutilisez un identifiant uniquement avec la même opération et les mêmes arguments. |
| 409 | `VOICE_CLONE_LIMIT_REACHED` | Tous les emplacements de voix de synthèse vocale personnalisées enregistrées sont occupés. |
| 409 | `VOICE_CREATION_IN_PROGRESS` | Ce candidat est toujours en cours d’enregistrement ou la suppression du compte bloque les nouvelles opérations sur les voix. |
| 410 | `VOICE_PREVIEW_EXPIRED` | Le candidat a expiré, n’est pas prêt ou ne dispose plus d’un aperçu audio utilisable. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Attendez la réinitialisation mensuelle ou changez de forfait. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Respectez Retry-After lorsqu’il est présent et espacez progressivement les nouvelles tentatives. |
| 500 | `INTERNAL_ERROR` | Vérifiez l’état de la requête enregistrée et l’historique de la ressource avant de décider de réessayer une mutation. |
| 502 | `INTERNAL_ERROR` | L’action n’a pas pu être finalisée ou son résultat n’a pas pu être confirmé. Vérifiez le statut de la requête et l’historique de la ressource avant de lancer une autre génération. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | L’action a été exécutée, mais son résultat n’a pas pu être enregistré. Consultez l’état de la requête enregistrée et l’historique de la ressource avant de lancer une nouvelle génération. |
| 503 | `SERVER_RESTARTING` | Le serveur redémarre. Réessayez dans un instant en conservant le même identifiant de requête pour une mutation. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["voices:write"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.