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

# Een projecttranscript ophalen of exporteren

> Haal het originele of vertaalde transcript op als JSON, SRT of VTT, met optionele sprekerlabels.

Haal het originele of vertaalde transcript op als JSON, SRT of VTT, met optionele sprekerlabels.

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

## Authenticatie en machtigingen

<ParamField header="x-api-key" type="string" required>
  Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
  worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
</ParamField>

Vereiste machtigingen: `transcription:read`.

Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.

## Parameters

<ParamField body="projectId" type="string" required>
  Tekstwaarde.

  Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/\\]+$`.
</ParamField>

<ParamField body="source" type="string">
  Tekstwaarde.

  Toegestane waarden: "original", "translated". Standaardwaarde: "original".
</ParamField>

<ParamField body="targetLanguage" type="string">
  Tekstwaarde.

  Toegestane waarden: "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">
  Tekstwaarde.

  Toegestane waarden: "json", "srt", "vtt". Standaardwaarde: "json".
</ParamField>

<ParamField body="includeSpeakerLabels" type="boolean">
  Booleaanse waarde.

  Standaardwaarde: false.
</ParamField>

<Accordion title="Volledig invoerschema">
  Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.

  ```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>

## Voorbeeldaanvragen

Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.

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

## Antwoord

Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden.

Retourneert een opgemaakt transcriptobject. JSON bevat format, transcript en contentType; SRT/VTT bevatten ook content en 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>

## Resultaatvelden

| Veld | Beschrijving |
| - | - |
| `data.format` | json, srt of vtt. |
| `data.contentType` | application/json, application/x-subrip; charset=utf-8, of text/vtt; charset=utf-8. |
| `data.content` | Ondertiteltekst alleen voor srt/vtt. |
| `data.fileExtension` | srt of vtt, alleen voor tekstexports. |
| `data.transcript.source` | original of translated. |
| `data.transcript.language` | Transcriptietaal. |
| `data.transcript.duration` | De hoogste waarde van de opgeslagen mediaduur en de eindtijd van het laatste segment, in seconden. |
| `data.transcript.text` | Samengevoegde niet-lege segmenttekst. |
| `data.transcript.speakers` | Unieke sprekers gesorteerd op numerieke id, met gegenereerde Speaker N-labels. |
| `data.transcript.segments` | Genormaliseerde segmenten gesorteerd op begin en index, met index, text, begin, end, duration, speaker, language en optioneel confidence, finalSpeedFactor, words. |
| `data.transcript.workId` | Aanwezig bij een vertaald transcript. |
| `data.transcript.targetLanguage` | Aanwezig bij een vertaald transcript. |
| `data.transcript.segments[].begin` | Starttijd in seconden, genormaliseerd tot drie decimalen. |
| `data.transcript.segments[].end` | Eindtijd in seconden, genormaliseerd tot drie decimalen. |
| `data.transcript.segments[].duration` | Positieve segmentduur in seconden. |
| `data.transcript.segments[].speaker` | Sprekernummer, beginnend bij nul. |
| `data.transcript.segments[].finalSpeedFactor` | Optionele duur van de vertaalde spraak gedeeld door het segmentvenster, afgerond op drie decimalen; waarden boven 1 geven aan dat de spraak versneld moest worden. |

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

Retourneert de vertaalde transcriptie en SRT-inhoud met sprekervoorvoegsels.

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

Retourneert de vertaalde transcriptie en WEBVTT-inhoud met stemlabels.

```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"
  }
}
```

## Opmerkingen bij de bewerking

* source is standaard original, outputFormat is standaard json en includeSpeakerLabels is standaard false. Een source met de waarde translated vereist targetLanguage.
* Voor vertaalde transcripties wordt de nieuwste taalversie geselecteerd die overeenkomt met targetLanguage. Deze actie heeft geen invoer voor workId of translatedVersionId.
* SRT- en VTT-exports blijven JSON-actieresultaten: content bevat de ondertiteltekst en transcript blijft beschikbaar in hetzelfde object. Deze handler retourneert geen onbewerkt downloadbaar antwoord.
* includeSpeakerLabels heeft alleen invloed op ondertitelblokken in tekstexports: SRT gebruikt Speaker N:-prefixen en VTT gebruikt stemtags.
* Opgeslagen transcriptiewoorden tonen, wanneer aanwezig, index, text, speaker en optioneel confidence; er worden geen tijdstempels op woordniveau verzonnen. Vertaalde segmenten kunnen finalSpeedFactor tonen wanneer er timing voor gegenereerde spraak bestaat.

## Verbruik

Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.

## Fouten

| HTTP-status | Code | Betekenis of herstel |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Inloggegevens zijn opgegeven in een queryparameter access\_token of api\_key. Stuur inloggegevens in headers. |
| 400 | `VALIDATION_ERROR` | Corrigeer de invoer aan de hand van het schema. Ongeldige of tegenstrijdige waarden worden vóór de uitvoering geweigerd. |
| 401 | `API_KEY_EXPIRED` | De API-sleutel is verlopen. |
| 401 | `INVALID_API_KEY` | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | `INVALID_CREDENTIAL` | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | `USER_NOT_FOUND` | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | `FORBIDDEN` | De geauthenticeerde uitvoerende gebruiker heeft geen toegang tot dit project. |
| 403 | `INSUFFICIENT_SCOPE` | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | `SUBSCRIPTION_REQUIRED` | Gebruik een actief betaald abonnement. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 404 | `PROJECT_NOT_FOUND` | Het project bestaat niet in het toegankelijke account. |
| 404 | `TRANSCRIPT_NOT_FOUND` | Er bestaat geen bruikbare transcriptie voor de gevraagde bron en doeltaal. |
| 409 | `TRANSCRIPT_NOT_READY` | De gevraagde oorspronkelijke of vertaalde transcriptie heeft nog de status processing. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | `INTERNAL_ERROR` | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 503 | `SERVER_RESTARTING` | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |

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