> ## 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 audios vocaux générés

> Listez votre historique de créations vocales, de la plus récente à la plus ancienne. Transmettez nextCursor comme cursor pour récupérer les créations plus anciennes.

Listez votre historique de créations vocales, de la plus récente à la plus ancienne. Transmettez nextCursor comme cursor pour récupérer les créations plus anciennes.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/tts_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: `tts: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

<ParamField body="limit" type="integer">
  Nombre entier.

  Minimum: 1. Maximum: 100. Valeur par défaut: 30.
</ParamField>

<ParamField body="cursor" type="string">
  Identifiant d’historique renvoyé par tts\_generate ou tts\_list.

  Motif: `^(free-)?[0-9a-f]{64}$`.
</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": {
      "limit": {
        "default": 30,
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      },
      "cursor": {
        "type": "string",
        "pattern": "^(free-)?[0-9a-f]{64}$",
        "description": "History ID returned by tts_generate or tts_list."
      }
    },
    "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/tts_list' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"limit":1}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    limit: 1,
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_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/tts_list",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"limit": 1},
      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.

Page de résumés de l’historique de synthèse vocale, du plus récent au plus ancien, et curseur permettant de demander les créations antérieures.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "items": [
        {
          "historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
          "textPreview": "Hello world.",
          "voice": "933563129e564b19a115bedd57b7406a",
          "voiceName": "Sarah",
          "voiceSource": "catalog",
          "inputType": "text",
          "instructionPreset": "narrator",
          "sourceFileName": "launch-script.txt",
          "characterCount": 12,
          "durationSeconds": 1.5,
          "isPreview": false,
          "createdAt": 1792152000000,
          "updatedAt": 1792152000000,
          "status": "success"
        }
      ],
      "nextCursor": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"
    }
  }
  ```
</ResponseExample>

## Champs du résultat

| Champ | Description |
| - | - |
| `data.items` | Résumés de l’historique vocal, du plus récent au plus ancien. |
| `data.items[].historyId` | ID d’historique de synthèse vocale vous appartenant : 64 caractères hexadécimaux minuscules, avec éventuellement le préfixe free- pour un aperçu de l’application. |
| `data.items[].voice` | L’ID de sélection TTS d’origine, y compris clone:\<UUID> pour une voix personnalisée enregistrée. |
| `data.items[].voiceName` | Nom d’affichage enregistré facultatif de la voix sélectionnée. |
| `data.items[].voiceSource` | Source facultative de la voix : catalog ou clone. |
| `data.items[].inputType` | Type d’entrée d’origine : text ou pdf. |
| `data.items[].instructionPreset` | Préréglage d’élocution enregistré. |
| `data.items[].sourceFileName` | Nom de fichier original facultatif fourni lors de la génération. |
| `data.items[].characterCount` | Nombre de caractères enregistré pour cette création de synthèse vocale. |
| `data.items[].durationSeconds` | Durée de l’audio en secondes. |
| `data.items[].createdAt` | Date de création sous forme d’horodatage Unix en millisecondes. |
| `data.items[].updatedAt` | Date de dernière modification sous forme d’horodatage Unix en millisecondes. |
| `data.items[].status` | Les créations vocales réussies enregistrées utilisent success ; tts\_generate utilise completed dans son résultat de génération. |
| `data.items[].textPreview` | 180 premiers caractères du script enregistré. |
| `data.items[].isPreview` | true lorsque l’audio contient uniquement un aperçu du script enregistré. |
| `data.nextCursor` | historyId du dernier élément pour une page complète, sinon null. |

## Notes de l’opération

* limit vaut 30 par défaut et accepte les valeurs de 1 à 100. Transmettez le nextCursor renvoyé dans cursor pour la page suivante.
* nextCursor vaut null lorsque moins de limit éléments sont renvoyés. Une dernière page complète peut tout de même renvoyer un curseur ; l’appel suivant peut être vide.
* Chaque textPreview contient au plus les 180 premiers caractères. Utilisez tts\_get pour obtenir le script complet et l’URL audio.
* Les éléments d’historique indiquent status: success. Cette valeur diffère de status: completed dans un résultat de synthèse vocale.
* 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. |
| 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": ["tts:read"]
  }
}
```


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