Skip to main content
POST
Reihen Sie eine Bearbeitung des Originaltexts oder einer Übersetzung ein. requestId muss für Wiederholungsversuche eine stabile UUID sein. Fragen Sie segment_actions_list ab, bis die Bearbeitung abgeschlossen ist.

Authentifizierung und Berechtigungen

string
erforderlich
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.
Erforderliche Berechtigungen: transcription:write. Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.

Parameter

string
erforderlich
Textwert.Mindestlänge: 1. Höchstlänge: 200. Muster: ^[^/\\]+$.
integer
erforderlich
Ganzzahliger Wert.Minimum: 0. Maximum: 9007199254740991.
string
An der Transportschnittstelle optional: Bei fehlender Angabe fügt der Server vor der Validierung eine Kennung ein. Geben Sie eine eigene stabile UUID v4 an, um eine verlorene Antwort sicher wiederherstellen zu können.Format: “uuid”. Muster: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
string
erforderlich
Textwert.Zulässige Werte: “original”, “translated”.
string
Textwert.Mindestlänge: 1. Höchstlänge: 200. Muster: ^[^/\\]+$.
string
erforderlich
Textwert.Höchstlänge: 3000.
boolean
Boolescher Wert.
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.

Idempotenz

Verwenden Sie für jede Mutation eine UUID v4 in requestId oder im HTTP-Header Idempotency-Key. Verwenden Sie nach einem Netzwerkfehler dieselbe Kennung und identische Argumente erneut. Wenn Sie beides angeben, müssen die Werte übereinstimmen. Die Wiederholung einer gespeicherten Anfrage führt die Operation nicht erneut aus und verbraucht keinen weiteren monatlichen Aufruf. Fehlgeschlagene oder unterbrochene Anfragen werden nicht automatisch neu gestartet. Jede Mutation kann HTTP 202 zurückgeben, wenn bei einem Wiederholungsversuch dieselbe Anfrage noch läuft, auch wenn ihre erste Ausführung normalerweise synchron erfolgt. Wenn die Ausführung abgeschlossen ist, resultStored aber false ist, gibt ein Wiederholungsversuch HTTP 200 mit dem gespeicherten Anfragestatus anstelle des ursprünglichen Ergebnisses zurück. Rufen Sie die Ausgabe über die für ihren Bereich vorgesehene Verlaufs-, Ergebnis- oder Downloadaktion ab.

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.

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 die Aufnahme in die Warteschlange sowie einen aktuellen Stand der Warteschlange für eine Bearbeitung des Originaltexts oder des übersetzten Texts zurück.

Ergebnisfelder

Diese Anfrage wiederherstellen und abfragen

Verwenden Sie auch nach einem Verbindungsabbruch dieselbe Kennung. Wenn resultStored den Wert false hat, rufen Sie die Ausgabe über die entsprechende Verlaufs-, Ergebnis- oder Downloadaktion ab. Starten Sie niemals eine zweite Generierung, nur um den Fortschritt zu prüfen.
HTTP 200

Hinweise zur Operation

  • Verwenden Sie für die beabsichtigte Bearbeitung eine requestId im Format UUID v4 und verwenden Sie diese bei Wiederholungsversuchen mit identischen Argumenten erneut. jobId entspricht dieser requestId.
  • Die Aufnahme gibt started oder queued zurück und bedeutet keinen Abschluss. Fragen Sie segment_actions_list regelmäßig ab und suchen Sie den Eintrag, dessen items[].id gleich jobId ist, bis completed, failed oder cancelled erreicht ist; aktualisieren Sie anschließend transcripts_get und projects_get.
  • queue.revision bildet den Zustand der Warteschlange ab; dies ist keine Revision der Quellsegmentstruktur. Warteschlangenaktionen erfassen bei der Aufnahme die aktuelle Struktur. Eine spätere inkompatible Strukturänderung kann zum Fehlschlagen des Eintrags mit SEGMENT_STRUCTURE_CHANGED führen.
  • Für dasselbe logische Segmentziel wird nur eine ausstehende Aktion angenommen. Eine neue requestId umgeht SEGMENT_ACTION_ALREADY_PENDING nicht.
  • Fehler bei der Ausführung der Warteschlange erscheinen als items[].status failed mit errorCode, anstatt das erfolgreiche Einreichungsergebnis zu ändern.
  • Lassen Sie bei Änderungen am Original workId und enableEditing weg. Änderungen am Originaltext markieren dieses Segment in jeder Sprachfassung als noch zu übersetzen; sie erzeugen nicht automatisch neue Sprache.
  • Verwenden Sie für die Bearbeitung von Übersetzungen source translated und geben Sie workId an. Die Berechtigungen transcription:write und translations:write sind beide erforderlich.
  • enableEditing ist nur bei der Bearbeitung von Übersetzungen zulässig und schaltet den manuellen Übersetzungsmodus ausdrücklich um. Eine Bearbeitung der Übersetzung aktualisiert Text und Bearbeitungsstatus, ohne die Sprachausgabe erneut zu generieren.
  • Das Aktionsschema erlaubt eine leere Textzeichenfolge. Verwenden Sie die dedizierte Aktion segments_delete, um ein Segment zu entfernen und alle Sprachen aufeinander abzustimmen.
  • Warteschlangenantworten enthalten auch bei Übermittlung, Abbruch, Abfrage und Wiederholung nur Aktionsmetadaten. Lesen Sie Transkriptinhalte mit transcripts_get und der erforderlichen Berechtigung transcription:read.

Nutzung

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

Fehler