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

# Consulter ou exporter la transcription d’un projet

> Récupérez la transcription originale ou traduite au format JSON, SRT ou VTT, avec les noms de locuteurs en option.

Récupérez la transcription originale ou traduite au format JSON, SRT ou VTT, avec les noms de locuteurs en option.

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

## 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: `transcription: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="projectId" type="string" required>
  Valeur textuelle.

  Longueur minimale: 1. Longueur maximale: 200. Motif: `^[^/\\]+$`.
</ParamField>

<ParamField body="source" type="string">
  Valeur textuelle.

  Valeurs acceptées: "original", "translated". Valeur par défaut: "original".
</ParamField>

<ParamField body="targetLanguage" type="string">
  Valeur textuelle.

  Valeurs acceptées: "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese", "azerbaijani", "basque", "belarusian", "bengali", "bosnian", "bulgarian", "catalan", "croatian", "czech", "danish", "dutch", "english", "british english", "estonian", "finnish", "french", "french canadian", "galician", "german", "greek", "gujarati", "hebrew", "hindi", "hungarian", "icelandic", "indonesian", "irish", "italian", "japanese", "kannada", "kazakh", "khmer", "korean", "lao", "latvian", "lithuanian", "macedonian", "malay", "malayalam", "mandarin", "marathi", "mongolian", "nepali", "norwegian", "persian", "polish", "portuguese", "brazilian portuguese", "pt\_brazil", "punjabi", "romanian", "russian", "serbian", "slovak", "slovenian", "spanish", "swahili", "swedish", "tagalog", "tamil", "telugu", "thai", "turkish", "ukrainian", "urdu", "vietnamese", "welsh", "yoruba", "zulu".
</ParamField>

<ParamField body="outputFormat" type="string">
  Valeur textuelle.

  Valeurs acceptées: "json", "srt", "vtt". Valeur par défaut: "json".
</ParamField>

<ParamField body="includeSpeakerLabels" type="boolean">
  Valeur booléenne.

  Valeur par défaut: false.
</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": {
      "projectId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      },
      "source": {
        "default": "original",
        "type": "string",
        "enum": ["original", "translated"]
      },
      "targetLanguage": {
        "type": "string",
        "enum": [
          "afrikaans",
          "albanian",
          "amharic",
          "arabic",
          "armenian",
          "assamese",
          "azerbaijani",
          "basque",
          "belarusian",
          "bengali",
          "bosnian",
          "bulgarian",
          "catalan",
          "croatian",
          "czech",
          "danish",
          "dutch",
          "english",
          "british english",
          "estonian",
          "finnish",
          "french",
          "french canadian",
          "galician",
          "german",
          "greek",
          "gujarati",
          "hebrew",
          "hindi",
          "hungarian",
          "icelandic",
          "indonesian",
          "irish",
          "italian",
          "japanese",
          "kannada",
          "kazakh",
          "khmer",
          "korean",
          "lao",
          "latvian",
          "lithuanian",
          "macedonian",
          "malay",
          "malayalam",
          "mandarin",
          "marathi",
          "mongolian",
          "nepali",
          "norwegian",
          "persian",
          "polish",
          "portuguese",
          "brazilian portuguese",
          "pt_brazil",
          "punjabi",
          "romanian",
          "russian",
          "serbian",
          "slovak",
          "slovenian",
          "spanish",
          "swahili",
          "swedish",
          "tagalog",
          "tamil",
          "telugu",
          "thai",
          "turkish",
          "ukrainian",
          "urdu",
          "vietnamese",
          "welsh",
          "yoruba",
          "zulu"
        ]
      },
      "outputFormat": {
        "default": "json",
        "type": "string",
        "enum": ["json", "srt", "vtt"]
      },
      "includeSpeakerLabels": {
        "default": false,
        "type": "boolean"
      }
    },
    "required": ["projectId"],
    "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/transcripts_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026","source":"original","outputFormat":"json","includeSpeakerLabels":false}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
    source: 'original',
    outputFormat: 'json',
    includeSpeakerLabels: false,
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/transcripts_get', {
    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/transcripts_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026", "source": "original", "outputFormat": "json", "includeSpeakerLabels": False},
      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.

Renvoie un objet de transcription formaté. Le JSON contient format, transcript et contentType ; les formats SRT/VTT incluent également content et fileExtension.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "format": "json",
      "transcript": {
        "source": "original",
        "language": "fr",
        "duration": 75,
        "text": "Bienvenue au lancement.",
        "speakers": [
          {
            "id": 0,
            "label": "Speaker 1"
          }
        ],
        "segments": [
          {
            "index": 0,
            "text": "Bienvenue au lancement.",
            "begin": 0,
            "end": 2,
            "duration": 2,
            "speaker": 0,
            "language": "fr"
          }
        ]
      },
      "contentType": "application/json"
    }
  }
  ```
</ResponseExample>

## Champs du résultat

| Champ | Description |
| - | - |
| `data.format` | json, srt ou vtt. |
| `data.contentType` | application/json, application/x-subrip; charset=utf-8, ou text/vtt; charset=utf-8. |
| `data.content` | Texte des sous-titres pour srt/vtt uniquement. |
| `data.fileExtension` | srt ou vtt, uniquement pour les exports de texte. |
| `data.transcript.source` | original ou translated. |
| `data.transcript.language` | Langue de la transcription. |
| `data.transcript.duration` | Maximum entre la durée du média stockée et la fin du dernier segment, en secondes. |
| `data.transcript.text` | Texte des segments non vides concaténé. |
| `data.transcript.speakers` | Locuteurs uniques triés par id numérique, avec des libellés générés Speaker N. |
| `data.transcript.segments` | Segments normalisés triés par begin et index, avec index, text, begin, end, duration, speaker, language et, éventuellement, confidence, finalSpeedFactor, words. |
| `data.transcript.workId` | Inclus pour une transcription traduite. |
| `data.transcript.targetLanguage` | Inclus pour une transcription traduite. |
| `data.transcript.segments[].begin` | Instant de début en secondes, normalisé à trois décimales. |
| `data.transcript.segments[].end` | Instant de fin en secondes, normalisé à trois décimales. |
| `data.transcript.segments[].duration` | Durée positive du segment en secondes. |
| `data.transcript.segments[].speaker` | Numéro de locuteur commençant à zéro. |
| `data.transcript.segments[].finalSpeedFactor` | Durée facultative de la parole traduite divisée par la plage temporelle de son segment, arrondie à trois décimales ; les valeurs supérieures à 1 indiquent que la parole a dû être accélérée. |

## outputFormat srt ; source translated, targetLanguage english, includeSpeakerLabels true.

Renvoie la transcription traduite et le contenu SRT avec les préfixes de locuteur.

```json HTTP 200 theme={null}
{
  "data": {
    "format": "srt",
    "transcript": {
      "source": "translated",
      "language": "english",
      "duration": 75,
      "text": "Welcome to the product launch.",
      "speakers": [
        {
          "id": 0,
          "label": "Speaker 1"
        }
      ],
      "segments": [
        {
          "index": 0,
          "text": "Welcome to the product launch.",
          "begin": 0,
          "end": 2,
          "duration": 2,
          "speaker": 0,
          "language": "english",
          "finalSpeedFactor": 1.08
        }
      ],
      "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
      "targetLanguage": "english"
    },
    "content": "1\n00:00:00,000 --> 00:00:02,000\nSpeaker 1: Welcome to the product launch.\n",
    "contentType": "application/x-subrip; charset=utf-8",
    "fileExtension": "srt"
  }
}
```

## outputFormat à vtt ; source à translated, targetLanguage à english, includeSpeakerLabels à true.

Renvoie la transcription traduite et le contenu WEBVTT avec les libellés des voix.

```json HTTP 200 theme={null}
{
  "data": {
    "format": "vtt",
    "transcript": {
      "source": "translated",
      "language": "english",
      "duration": 75,
      "text": "Welcome to the product launch.",
      "speakers": [
        {
          "id": 0,
          "label": "Speaker 1"
        }
      ],
      "segments": [
        {
          "index": 0,
          "text": "Welcome to the product launch.",
          "begin": 0,
          "end": 2,
          "duration": 2,
          "speaker": 0,
          "language": "english",
          "finalSpeedFactor": 1.08
        }
      ],
      "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
      "targetLanguage": "english"
    },
    "content": "WEBVTT\n\n1\n00:00:00.000 --> 00:00:02.000\n<v Speaker 1>Welcome to the product launch.\n",
    "contentType": "text/vtt; charset=utf-8",
    "fileExtension": "vtt"
  }
}
```

## Notes de l’opération

* source vaut original par défaut, outputFormat vaut json et includeSpeakerLabels vaut false. Une source traduite exige targetLanguage.
* Pour les transcriptions traduites, le travail de traduction le plus récent correspondant à targetLanguage est sélectionné. Cette action ne possède aucun paramètre d’entrée workId ou translatedVersionId.
* Les exports SRT et VTT restent des résultats d’action JSON : content contient le texte des sous-titres et transcript reste disponible dans le même objet. Ce gestionnaire ne renvoie pas de réponse brute téléchargeable.
* includeSpeakerLabels affecte uniquement les blocs de l’export texte : SRT utilise des préfixes Speaker N: et VTT utilise des balises de voix.
* Les mots de transcription stockés, lorsqu’ils sont présents, exposent index, text, speaker et, facultativement, confidence ; aucun horodatage par mot n’est inventé. Les segments traduits peuvent exposer finalSpeedFactor lorsque le minutage de la voix générée existe.

## 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` | Corrigez l’entrée à l’aide du schéma. Les valeurs invalides ou incohérentes sont refusées avant l’exécution. |
| 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 | `FORBIDDEN` | L’appelant authentifié ne peut pas accéder à ce projet. |
| 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 | `PROJECT_NOT_FOUND` | Le projet n’existe pas dans le compte accessible. |
| 404 | `TRANSCRIPT_NOT_FOUND` | Aucune transcription exploitable n’existe pour la source et la langue cible demandées. |
| 409 | `TRANSCRIPT_NOT_READY` | La transcription originale ou traduite demandée est encore en cours de traitement. |
| 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": ["transcription:read"]
  }
}
```


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