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

# Sprachfassung abrufen

> Rufen Sie Metadaten einer Sprachfassung, Indizes ausstehender Segmente und normalisierte Ausgabeversionen ab.

Rufen Sie Metadaten einer Sprachfassung, Indizes ausstehender Segmente und normalisierte Ausgabeversionen ab.

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

## Authentifizierung und Berechtigungen

<ParamField header="x-api-key" type="string" required>
  Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt.
  OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
</ParamField>

Erforderliche Berechtigungen: `projects:read`.

Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.

## Parameter

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

  Mindestlänge: 1. Höchstlänge: 200. Muster: `^[^/\\]+$`.
</ParamField>

<ParamField body="workId" type="string" required>
  Textwert.

  Mindestlänge: 1. Höchstlänge: 200. Muster: `^[^/\\]+$`.
</ParamField>

<Accordion title="Vollständiges Eingabeschema">
  Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "projectId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      },
      "workId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      }
    },
    "required": ["projectId", "workId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Anfragebeispiele

Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026","workId":"5f8423d1-e4c0-4f80-9e3f-eed959389e24"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
    workId: '5f8423d1-e4c0-4f80-9e3f-eed959389e24',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_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/translations_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026", "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Antwort

Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder.

Gibt eine autorisierte Projektion einer Sprachfassung und ihre öffentlichen Versionen zurück.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
      "projectId": "project_launch_2026",
      "targetLanguage": "english",
      "originalLanguage": "fr",
      "createdAt": 1792152000000,
      "isWorkWaitingForProofreading": false,
      "pendingSegmentIndexes": [],
      "versions": [
        {
          "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
          "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
          "targetLanguage": "english",
          "status": "completed",
          "currentStep": "done",
          "progress": 100,
          "createdAt": 1792152060000,
          "completedAt": 1792152300000,
          "translatedVideoUrl": "https://media.example.com/launch/english.mp4",
          "translatedAudioUrl": "https://media.example.com/launch/english.mp3",
          "settings": {
            "voiceCloning": true,
            "uploadType": "video",
            "keepBackgroundMusic": true,
            "keepOriginalVoice": false,
            "originalVoiceVolume": 30,
            "subtitles": {
              "isEnable": false,
              "source": "translated"
            },
            "smartSync": true,
            "dubbingMode": "translate",
            "voiceIsolatorOption": "studio"
          }
        }
      ]
    }
  }
  ```
</ResponseExample>

## Ergebnisfelder

| Feld | Beschreibung |
| - | - |
| `data.workId` | Kennung der Sprachfassung. |
| `data.projectId` | Kennung des übergeordneten Projekts. |
| `data.targetLanguage` | Zielsprache. |
| `data.originalLanguage` | Quellsprache. |
| `data.createdAt` | Erstellungszeit der Sprachfassung, normalisiert auf Unix-Millisekunden. |
| `data.isWorkWaitingForProofreading` | Korrekturlesestatus; false, wenn nicht ausdrücklich festgelegt. |
| `data.pendingSegmentIndexes` | Noch zu übersetzende Quellsegmentindizes, standardmäßig ein leeres Array. |
| `data.versions` | Alle öffentlichen Versionen dieser Sprachfassung, neueste zuerst sortiert. |
| `data.versions[].workId` | Kennung der Sprachfassung, die diese Version enthält. |
| `data.versions[].translatedVersionId` | Kennung einer bestimmten Version der Synchronisationsausgabe. |
| `data.versions[].targetLanguage` | Zielsprache der Version, ersatzweise die ihrer Sprachfassung. |
| `data.versions[].status` | Gespeicherter Versionsstatus: not-started, in-progress, completed oder failed. |
| `data.versions[].currentStep` | Optionaler Schritt im Synchronisationsablauf; progress ist ein optionaler numerischer Fortschrittswert. |
| `data.versions[].progress` | Optionaler Fortschrittswert der Synchronisation. |
| `data.versions[].createdAt` | Auf Unix-Millisekunden normalisierter Erstellungszeitpunkt; verwendet ersatzweise den Erstellungszeitpunkt der Sprachfassung. |
| `data.versions[].completedAt` | Optionaler Abschlusszeitpunkt in Unix-Millisekunden. |
| `data.versions[].failedAt` | Optionaler Fehlerzeitpunkt in Unix-Millisekunden. |
| `data.versions[].timedOutAt` | Optionaler Zeitüberschreitungszeitpunkt in Unix-Millisekunden. |
| `data.versions[].translatedVideoUrl` | Gespeicherte URL des übersetzten Videos oder eine leere Zeichenfolge, wenn sie nicht verfügbar ist. |
| `data.versions[].translatedAudioUrl` | Gespeicherte URL des übersetzten Audios oder eine leere Zeichenfolge, wenn sie nicht verfügbar ist. |
| `data.versions[].error` | Optionales \{code,message}, wenn die Version fehlgeschlagen ist. |
| `data.versions[].settings` | Öffentliche Versionseinstellungen: voiceCloning, uploadType, keepBackgroundMusic, keepOriginalVoice, originalVoiceVolume, subtitles, smartSync, dubbingMode, voiceIsolatorOption und optional translationQualityMode, cutBecauseFreeUser, originalDurationSeconds, cutDurationSeconds, voiceCloningSettings. |
| `data.versions[].settings.dubbingMode` | translate oder dub-only. SmartSync ist bei dub-only-Versionen false. |
| `data.versions[].lipSync` | Optionales \{latest,history}; jeder Eintrag enthält jobId, status, videoUrl, errorMessage, type, createdAt und optional requestedAt, retryRequestedAt, completedAt, failedAt, timedOutAt, activeSpeakerDetectionEnabled, isRetried. Zeitangaben der Lippensynchronisation werden als ISO-Zeichenfolgen gespeichert. |
| `data.versions[].dynamicSubtitles` | Optionales Objekt mit used, inProgress, magicZooms, magicBrolls, magicBrollsPercentage, videoUrl, errorMessage und optional removeSilencePace, removeBadTakes, templateName, requestedAt, rerunCount. requestedAt wird in Unix-Millisekunden angegeben. |
| `data.versions[].publicationAttempts` | Optionales Array mit öffentlichen Veröffentlichungsversuchen: id, status, origin sowie optional scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
| `data.versions[].publishedVideos` | Optionales Array mit type, videoId, privacyStatus und optional url, datePublished, origin, scheduledAt, plannedPublicationId. |

## Hinweise zur Operation

* workId muss zu projectId gehören und denselben gespeicherten Projektinhaber haben.
* pendingSegmentIndexes listet Text auf, der noch übersetzt werden muss; die Liste ist von der Warteschlange für Segmentaktionen getrennt.
* Gespeicherte Fehler liefern VoiceCheap-Fehlercodes und feste Meldungen. Nutzen Sie den Code und den aktuellen Ressourcenstatus, um über die Fehlerbehebung zu entscheiden.

## Nutzung

Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.

## Fehler

| HTTP-Status | Code | Bedeutung oder Behebung |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Zugangsdaten wurden in einem Abfrageparameter namens access\_token oder api\_key übergeben. Senden Sie Zugangsdaten in Headern. |
| 400 | `VALIDATION_ERROR` | Korrigieren Sie die Eingabe anhand des Schemas. Ungültige oder widersprüchliche Werte werden vor der Ausführung abgelehnt. |
| 401 | `API_KEY_EXPIRED` | Der API-Schlüssel ist abgelaufen. |
| 401 | `INVALID_API_KEY` | Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an. |
| 401 | `INVALID_CREDENTIAL` | Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen. |
| 401 | `USER_NOT_FOUND` | Das Konto des Zugangsnachweises existiert nicht mehr. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. |
| 403 | `FORBIDDEN` | Der authentifizierte Akteur kann auf dieses Projekt nicht zugreifen. |
| 403 | `INSUFFICIENT_SCOPE` | Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | `SUBSCRIPTION_REQUIRED` | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 404 | `PROJECT_NOT_FOUND` | Das Projekt ist im zugänglichen Konto nicht vorhanden. |
| 404 | `TRANSLATION_NOT_FOUND` | workId bezeichnet keine Sprachfassung, die diesem Projekt gehört. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle. |
| 500 | `INTERNAL_ERROR` | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 503 | `SERVER_RESTARTING` | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. |

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


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