Skip to main content

​
API-Referenz

Die VoiceCheap-API verwendet Standard-HTTP-Methoden und -Statuscodes. Die meisten Endpunkte geben JSON zurück; Transkript-Exporte können auch SRT oder VTT zurückgeben. Verwenden Sie für Kontoeinstellungen, Teamverwaltung, Medientools und weitere Abläufe den Aktionskatalog. Diese Abläufe sind auch über den MCP-Server für das Konto verfügbar. Das Erstellen und Rotieren von Webhook-Signaturschlüsseln erfordert jedoch REST. Verwalten Sie Zugangsdaten unter Integrationen und prüfen Sie die Nutzungslimits.

​
Basis-URL

Alle API-Anfragen sollten an folgende Adresse gerichtet werden:

​
Authentifizierung

Authentifizieren Sie private REST-Aufrufe mit einem API-Schlüssel in x-api-key oder Authorization: Bearer. Das OpenAPI-Dokument ist öffentlich. Informationen zu Zugangsdaten mit begrenzten Berechtigungen und OAuth für MCP finden Sie unter Authentifizierung.

​
JSON-Aktions-API

Die Bereiche für Konto, Team, Projekte, Stimmen und Medienwerkzeuge dokumentieren jede JSON-Aktion einzeln. Alle diese Routen verwenden POST, auch zum Lesen und Löschen; senden Sie die Argumente im JSON-Body. Die Datei-Upload- und bestehenden Projektrouten unten behalten ihre eigenen HTTP-Methoden. Erstellen Sie einen API-Schlüssel mit account:read, setzen Sie die Umgebungsvariable VOICECHEAP_API_KEY und testen Sie diese schreibgeschützte Anfrage:
Eine abgeschlossene Aktion liefert HTTP 200 mit dem Ergebnis in data. Eine länger laufende Aktion liefert HTTP 202 und eine requestId; rufen Sie den Anfragestatus ab, um das Ergebnis zu erhalten. Ein Medienauftrag kann nach Abschluss der Aktionsanfrage weiterlaufen. Öffnen Sie alle Aktionsseiten nach Bereich oder ermitteln Sie die für Ihren Schlüssel erlaubten Aktionen und Schemas. Jede Seite nennt die genauen Berechtigungen, Parameter, Beispiele und Fehler.

​
Inhaltstypen

  • Anfrage: Verwenden Sie multipart/form-data für Datei-Uploads, application/json für andere Anfragen
  • Antwort: JSON-Endpunkte geben application/json zurück. Transkript-Exporte können auch SRT- oder VTT-Text zurückgeben.

​
Datei-Uploads und bestehende Projektrouten

Medien transkribieren

POST /v1/transcribeTranskribieren Sie eine hochgeladene Datei als JSON, SRT oder VTT.

Projekttranskript exportieren

POST /v1/projects/{projectId}/transcriptRufen Sie originale oder übersetzte Projekttranskripte ab.

Projekt erstellen

POST /v1/projectsLaden Sie eine Video- oder Audiodatei hoch und starten Sie nur die Transkription.

Übersetzung starten

POST /v1/translateLaden Sie eine Video- oder Audiodatei hoch und starten Sie ein Übersetzungsprojekt.

Projekt synchronisieren

POST /v1/projects/{projectId}/dubVertonen Sie ein transkribiertes Projekt mit Ihrer eigenen übersetzten SRT-Datei.

Übersetzungsstatus abrufen

GET /v1/translate/{projectId}/statusÜberprüfen Sie den Status eines Übersetzungsprojekts und rufen Sie die Ergebnisse ab.

Projektdetails abrufen

GET /v1/projects/{projectId}Rufen Sie die Historie der übersetzten Versionen, die Historie der Lippensynchronisation und den Projektstatus ab.

Projekt löschen

DELETE /v1/translate/{projectId}Löschen Sie ein Übersetzungsprojekt und dessen Assets dauerhaft.

​
Übersetzungs-Workflow

Der typische Workflow für die Übersetzung eines Videos ist:

​
Antwortformat

Die folgenden bestehenden Datei-Upload- und Projektrouten behalten ihre jeweiligen Antwortformate. Die Felder einer erfolgreichen Antwort hängen vom Endpunkt ab. Anfragen zum Erstellen eines Projekts oder Starten einer Synchronisation geben success, message und projectId zurück. Status- und Projektdetailanfragen liefern den Projektzustand; Transkriptanfragen geben JSON, SRT oder VTT zurück. Die genauen Felder stehen auf der jeweiligen Endpunktseite. Fehler geben ein JSON-Objekt mit code und message zurück, manchmal auch mit details. Siehe Fehlercodes.

​
HTTP-Statuscodes