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

# Lister les voix et leurs aperçus

> Listez les voix de synthèse disponibles, vos voix personnalisées enregistrées, les aperçus non expirés à écouter et vos quotas de création de voix.

Listez les voix de synthèse disponibles, vos voix personnalisées enregistrées, les aperçus non expirés à écouter et vos quotas de création de voix.

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

## 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:read`.

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

Envoyez un objet JSON vide. Cette action ne comporte aucun champ d’entrée.

<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": {},
    "additionalProperties": false
  }
  ```
</Accordion>

## 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_list' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{}'
  ```

  ```javascript JavaScript theme={null}
  const input = {};
  const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_list', {
    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_list",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Réponse

Une première exécution réussie renvoie HTTP 200 avec le résultat de l’opération sous data. Une nouvelle tentative peut renvoyer à la place l’état de la requête enregistrée. L’exemple présente une réponse possible, sans tous les champs facultatifs.

Voix disponibles du catalogue de synthèse vocale et voix personnalisées enregistrées appartenant à l’acteur, quota d’emplacements enregistrés, aperçus actifs non enregistrés et quotas de création de voix.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "voices": [
        {
          "accent": "original",
          "id": "clone:33333333-3333-4333-8333-333333333333",
          "name": "Studio narrator",
          "previewUrl": "https://files.example.com/saved-narrator.mp3",
          "source": "clone"
        },
        {
          "id": "933563129e564b19a115bedd57b7406a",
          "name": "Sarah",
          "accent": "english",
          "gender": "female",
          "style": "conversational",
          "previewFileName": "sarah-en.mp3",
          "source": "catalog"
        }
      ],
      "cloneUsage": {
        "canClone": true,
        "limit": 10,
        "remaining": 9,
        "used": 1
      },
      "voicePreviews": [
        {
          "id": "44444444-4444-4444-8444-444444444444",
          "kind": "clone",
          "name": "Studio narrator",
          "previewUrl": "https://files.example.com/narrator-preview.mp3",
          "expiresAt": 1792238400000,
          "durationSeconds": 10
        }
      ],
      "creationUsage": {
        "cloneTrial": {
          "limit": 1,
          "used": 1,
          "remaining": 0
        },
        "design": {
          "limit": 5,
          "used": 0,
          "remaining": 5,
          "resetsAt": 1792195200000
        },
        "previewExpiresAfterHours": 24
      }
    }
  }
  ```
</ResponseExample>

## Champs du résultat

| Champ | Description |
| - | - |
| `data.voices` | Voix TTS enregistrées vous appartenant, suivies des voix disponibles du catalogue. |
| `data.voices[].id` | ID de sélection TTS pour tts\_generate ; les valeurs personnalisées utilisent clone:\<UUID>. |
| `data.voices[].name` | Nom affiché de la voix. |
| `data.voices[].source` | catalog ou clone. |
| `data.voices[].accent` | Accent de la voix ; original pour les voix personnalisées. |
| `data.voices[].gender` | Genre facultatif de la voix du catalogue. |
| `data.voices[].style` | Style d’élocution facultatif de la voix du catalogue. |
| `data.voices[].previewFileName` | Nom de fichier facultatif de l’aperçu fourni avec le catalogue ; il ne s’agit pas d’une URL de téléchargement. |
| `data.voices[].previewUrl` | URL de lecture facultative ; les URL des voix personnalisées sont temporaires. |
| `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. |
| `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. |

## Notes de l’opération

* Le catalogue de l’exemple est abrégé. L’action renvoie la bibliothèque TTS disponible, avec les voix personnalisées enregistrées avant les entrées du catalogue.
* Utilisez voices\[].id dans tts\_generate. Les voix enregistrées utilisent clone:\<UUID> ; les identifiants du catalogue sont opaques. Ces identifiants sont distincts de ceux de dubbing\_voices\_list.
* Les entrées du catalogue comprennent accent, gender, style et previewFileName ; previewUrl est facultatif. Les entrées personnalisées enregistrées comprennent accent: original, source: clone et un previewUrl temporaire.
* canClone indique si l’offre prend en charge les voix TTS personnalisées enregistrées ; remaining indique le nombre d’emplacements libres. Les créations réservées peuvent être comptabilisées dans used.
* voicePreviews inclut uniquement les candidats appartenant à l’utilisateur, non enregistrés, prêts et non expirés. Un aperçu dure 24 heures ; son URL de lecture peut expirer plus tôt.
* cloneTrial est un quota valable à vie pour un aperçu de clonage. Les offres payantes autorisent cinq requêtes de conception par jour UTC ; chaque conception réussie crée deux candidats. creationUsage indique le quota actuel et la date de réinitialisation.
* 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 | `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 | `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. |
| 404 | `USER_NOT_FOUND` | Le compte authentifié n’existe plus. |
| 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. |
| 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:read"]
  }
}
```


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