> ## 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.
# SRT-Untertitel erstellen
> Erstellen Sie bearbeitbare SRT-Untertitel aus hochgeladenem Audio oder Video, optional mit Einstellungen zum Untertitellayout. Gibt einen kompakten Verweis auf das gespeicherte Ergebnis zurück; verwenden Sie dessen getAction oder downloadAction, um die vollständige Ausgabe abzurufen.
Erstellen Sie bearbeitbare SRT-Untertitel aus hochgeladenem Audio oder Video, optional mit Einstellungen zum Untertitellayout. Gibt einen kompakten Verweis auf das gespeicherte Ergebnis zurück; verwenden Sie dessen getAction oder downloadAction, um die vollständige Ausgabe abzurufen.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/subtitles_create
```
## Authentifizierung und Berechtigungen
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: `subtitles:write`.
Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.
## Parameter
Ein eigener fileKey, der von einem abgeschlossenen Upload oder Medienimport zurückgegeben wurde. Jede Generierung verbraucht ihre hochgeladene Quelle.
Mindestlänge: 1. Höchstlänge: 1024.
Textwert.
Mindestlänge: 1. Höchstlänge: 255. Muster: `^[^/\\\r\n\0]+$`.
Liste von Werten. Die Struktur der Elemente finden Sie im vollständigen Eingabeschema.
Höchstanzahl an Elementen: 100.
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}$`.
JSON-Objekt. Die verschachtelten Felder finden Sie im vollständigen 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": {
"fileKey": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"description": "An owned fileKey returned by a completed upload or media import. Each generation consumes its uploaded source."
},
"fileName": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[^/\\\\\\r\\n\\0]+$"
},
"keyterms": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"requestId": {
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
"type": "string",
"format": "uuid",
"pattern": "^[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}$"
},
"subtitleLayout": {
"type": "object",
"properties": {
"maxLinesPerCaption": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
},
{
"type": "number",
"const": 3
}
]
},
"maxCharactersPerLine": {
"type": "integer",
"minimum": 24,
"maximum": 64
}
},
"required": ["maxLinesPerCaption", "maxCharactersPerLine"],
"additionalProperties": false
}
},
"required": ["fileKey"],
"additionalProperties": false
}
```
## 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.
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_create' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"fileKey":"uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4","fileName":"interview.mp4","subtitleLayout":{"maxLinesPerCaption":2,"maxCharactersPerLine":42},"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
```
```javascript JavaScript theme={null}
const input = {
fileKey: 'uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4',
fileName: 'interview.mp4',
subtitleLayout: {
maxLinesPerCaption: 2,
maxCharactersPerLine: 42,
},
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_create', {
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/subtitles_create",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4", "fileName": "interview.mp4", "subtitleLayout": {"maxLinesPerCaption": 2, "maxCharactersPerLine": 42}, "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## Antwort
Diese Operation gibt während der Ausführung HTTP 202 zurück. Speichern Sie requestId und fragen Sie action\_request\_get mit dieser Kennung und dem ursprünglichen Operationsnamen ab. Die Abfragestatus sind running, completed, failed und interrupted. Ein abgeschlossenes Ergebnis kann auf einen separaten Medienauftrag verweisen; verwenden Sie anschließend die für die Operation vorgesehene Status- oder Ausgabeaktion.
Eine Referenz auf ein gespeichertes Untertitelergebnis. Sein vollständiges JSON enthält srt, sourceSrt, layoutOptions, styleOptions und optional detectedLanguage, historyId, revision und updatedAt.
```json HTTP 202 theme={null}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
```
```json HTTP 200 theme={null}
{
"data": {
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "subtitles_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-subtitles_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 411,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "subtitles_result_get",
"downloadAction": "subtitles_result_download",
"listAction": "subtitles_result_list"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_create",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
```
```json HTTP 200 replay_completed_without_result theme={null}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_create",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
```
## Ergebnisfelder
| Feld | Beschreibung |
| - | - |
| `data.resultId` | UUID einer eigenen gespeicherten Ausgabe. Verwenden Sie sie mit getAction oder downloadAction; sie unterscheidet sich von requestId und jeder historyId. |
| `data.operation` | Generierungsaktion, die dieses gespeicherte JSON erzeugt hat. |
| `data.createdAt` | Unix-Zeitstempel in Millisekunden, zu dem die gespeicherte Ausgabe vorbereitet wurde. |
| `data.fileName` | Vorgeschlagener Dateiname für einen JSON-Export. |
| `data.byteLength` | UTF-8-Bytes der vollständigen serialisierten Ausgabe, nicht der kompakten Metadaten. |
| `data.contentType` | application/json; charset=utf-8. |
| `data.status` | completed bei erfolgreicher Generierung. Der Ergebnisverlauf kann auch ausstehende Wiederherstellungseinträge enthalten. |
| `data.requestId` | UUID der ursprünglichen Aktionsanfrage, sofern aufgezeichnet. |
| `data.getAction` | Aktion zum Abrufen eigener Inhalte; includeContent hat den Standardwert false und muss für eine vollständige strukturierte Ausgabe true sein. |
| `data.downloadAction` | Authentifizierte Exportaktion, die das vollständige JSON als Inhaltszeichenfolge zurückgibt. |
| `data.listAction` | Aktion zum Auflisten gespeicherter Ausgaben Ihres Kontos für diesen Berechtigungsbereich. |
## 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.
```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"subtitles_create"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_create",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "subtitles_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-subtitles_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 411,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "subtitles_result_get",
"downloadAction": "subtitles_result_download",
"listAction": "subtitles_result_list"
}
}
}
```
## Hinweise zur Operation
* Erfordert ein kostenpflichtiges Abonnement und die Aktionsberechtigung. Der persönliche Tooltarif des handelnden Kontos wird bei der Ausführung erneut geprüft; gespeicherte Tools und Uploadreferenzen gehören diesem Konto, auch wenn die Zugangsdaten einem Team zugeordnet sind.
* Eine erfolgreiche Aktion verbraucht einen gemeinsamen monatlichen API/MCP-Aufruf. Beginner erlaubt 500, Starter 5,000 und Creator 25,000 Aufrufe/Monat; Pro, Scale und Enterprise haben keine monatliche Obergrenze. Limits pro Minute gelten weiterhin: jeweils 30, 60, 120, 180, 300 und 600. Generierungskontingente der Werkzeuge sind davon getrennt.
* Verwenden Sie eine UUID v4 als requestId oder einen identischen Idempotency-Key-Header und behalten Sie bei erneuten Versuchen dieselbe Aktion, ID und dieselben Argumente bei. Eine zwischengespeicherte Wiederholung verbraucht keinen weiteren monatlichen Aufruf.
* Dies ist eine asynchrone Aktion. Das erste Transportergebnis ist eine Anfrage im Status running mit pollAction; fragen Sie action\_request\_get mit diesem Vorgang und der ursprünglichen requestId regelmäßig ab. Das hier gezeigte Ergebnis des abgeschlossenen Vorgangs ist eine kompakte Referenz auf die gespeicherte Ausgabe, kein generierter Body.
* Die vollständige Ausgabe wird unabhängig vom begrenzten Cache für die Aktionsabfrage mit authentifizierter Eigentümerschaft in einem verschlüsselten Speicher gesichert. Rufen Sie das zurückgegebene getAction mit resultId und includeContent: true für strukturiertes JSON oder downloadAction mit resultId für JSON-Text auf. listAction bietet einen Wiederherstellungsweg, wenn nur die ursprüngliche Anfrage bekannt ist.
* Das gespeicherte JSON ist auf 32 MiB begrenzt. Die Metadaten legen niemals seinen Speicherverschlüsselungsschlüssel oder eine nicht authentifizierte Download-URL für das Transkript offen.
* Eine erfolgreiche Generierung rechnet eine Einheit des persönlichen Werkzeugkontingents ab. Eine fehlgeschlagene Generierung gibt ihre Werkzeugreservierung normalerweise frei. Wenn die dauerhafte Speicherung der Ausgabe ungewiss ist, prüfen Sie dieselbe Anfrage und den Verlauf gespeicherter Ergebnisse, bevor Sie erneut generieren; der Server behält die Reservierung bei, um eine doppelte Nutzung zu verhindern.
* Höhere Tarife ohne monatliche Integrationsobergrenze unterliegen weiterhin den unten aufgeführten werkzeugspezifischen Tageskontingenten und Medienlimits. Diese eigenständigen Aktionen verwenden ihr Werkzeugkontingent statt Synchronisationsminuten oder TTS-Zeichen.
* Verwenden Sie fileKey aus einem abgeschlossenen Upload oder Import Ihres Kontos und behandeln Sie ihn als nur einmal verwendbar. Sobald die Medienverarbeitung beginnt, löscht die Bereinigung die Quelle nach erfolgreicher oder fehlgeschlagener Verarbeitung. Bei einer Ablehnung während der Validierung oder Kontingentprüfung vor der Verarbeitung kann sie erhalten bleiben. Verwenden Sie die ursprüngliche requestId erneut, um die angenommene Generierung wieder abzurufen, bevor Sie eine weitere starten.
* Akzeptiert unterstützte Audio- oder Videodateien bis 300 MiB und 2 Stunden. subtitleLayout erfordert sowohl maxLinesPerCaption (1, 2 oder 3) als auch maxCharactersPerLine (24 bis 64). Die Standardwerte sind 2 und 42.
* Tägliches Kontingent pro Tool: Beginner 5, Starter 15, Creator 30, Pro 60, Scale 100 und Enterprise 100 erfolgreiche Generierungen. Es wird mit dem entsprechenden Web-Tool geteilt und verwendet das Zurücksetzungsfenster des Konto-Tools.
* srt ist der gemäß Layout formatierte Text; sourceSrt bewahrt die generierte Quelle. historyId, revision und updatedAt sind nur vorhanden, wenn der bearbeitbare Untertitelverlauf erfolgreich gespeichert wurde. Lesen Sie vor einer Aktualisierung seine neueste Revision.
## 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 | `DURATION_TOO_LONG` | Die Medien überschreiten die Dauerbegrenzung des Vorgangs. |
| 400 | `DURATION_UNKNOWN` | Der Ausführungsschritt konnte keine positive Mediendauer ermitteln. |
| 400 | `FILE_TOO_LARGE` | Die gespeicherte Quelle überschreitet die operationsspezifische Bytegrenze. |
| 400 | `IDEMPOTENCY_CONFLICT` | Die Anfrage-IDs im Header und im Body unterscheiden sich. |
| 400 | `INVALID_FILE_TYPE` | Die Dateinamenerweiterung wird für diesen Vorgang nicht unterstützt. |
| 400 | `INVALID_MEDIA_DURATION` | Die ermittelte Quelldauer fehlt, ist ungültig oder überschreitet die Dauerbegrenzung des Tarifs. |
| 400 | `INVALID_MEDIA_STREAM` | Die Quelle enthält keine nutzbare Audiospur für die Transkription. |
| 400 | `INVALID_REQUEST_ID` | requestId oder Idempotency-Key ist keine UUID v4. |
| 400 | `VALIDATION_ERROR` | Die Argumente entsprechen nicht dem Aktionsschema, oder es wurde ein unbekanntes Argument angegeben. |
| 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 | `ACCOUNT_UNAVAILABLE` | Das ausführende Konto oder das Abrechnungskonto ist nicht verfügbar oder wird gerade gelöscht. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. |
| 403 | `INSUFFICIENT_SCOPE` | Dem API-Schlüssel oder der MCP-Verbindung fehlt die erforderliche Aktionsberechtigung. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | `INVALID_FILE_REFERENCE` | fileKey ist keine gültige abgeschlossene Upload-Referenz des ausführenden Benutzers. |
| 403 | `PAID_SUBSCRIPTION_REQUIRED` | Der authentifizierte Akteur hat kein kostenpflichtiges Abonnement mehr, wenn diese Werkzeugaktion ausgeführt wird. |
| 403 | `SUBSCRIPTION_REQUIRED` | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 404 | `MEDIA_NOT_FOUND` | Der abgeschlossene Quellupload fehlt oder ist leer; eine frühere Generierung hat ihn möglicherweise verbraucht. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Für dieses Konto laufen bereits 10 Integrationsaktionen. Fragen Sie eine vorhandene Anfrage ab, bevor Sie eine weitere starten. |
| 409 | `IDEMPOTENCY_CONFLICT` | Verwenden Sie eine Kennung nur mit derselben Operation und denselben Argumenten erneut. |
| 410 | `TOOL_RESULT_ACCOUNT_UNAVAILABLE` | Das Konto des Akteurs wird gelöscht oder existiert nicht mehr, daher kann kein dauerhaftes Ergebnis gespeichert werden. |
| 413 | `TOOL_RESULT_TOO_LARGE` | Das vollständig generierte JSON überschreitet 32 MiB und kann nicht als Integrationsergebnis gespeichert werden. |
| 422 | `SRT_EMPTY` | Es wurde kein gesprochener Untertitelinhalt erkannt. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Verbrauchte und ausstehende Aufrufe haben das gemeinsame monatliche API/MCP-Kontingent erreicht. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Das Konto hat sein Integrationslimit pro Minute erreicht; prüfen Sie retryAfterSeconds. |
| 429 | `VIDEO_TO_SRT_TOOL_DAILY_LIMIT_REACHED` | Der ausführende Benutzer hat das tägliche Kontingent des Video-zu-SRT-Tools ausgeschöpft. |
| 500 | `INTERNAL_ERROR` | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 502 | `INTERNAL_ERROR` | Die Generierung oder das Speichern der Ausgabe ist fehlgeschlagen. Prüfen Sie die ursprüngliche Anfrage und den Verlauf gespeicherter Ergebnisse, bevor Sie eine weitere Generierung starten. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | Die Aktion wurde ausgeführt, aber die dauerhafte Speicherung des Anfrageergebnisses konnte nicht bestätigt werden. Fragen Sie dieselbe Aktion mit derselben requestId regelmäßig ab und prüfen Sie den Ressourcenverlauf, bevor Sie einen weiteren Schreibvorgang starten. |
| 503 | `INTERNAL_ERROR` | Der Ausgang der Generierung oder der dauerhaften Ergebnisspeicherung ist ungewiss oder vorübergehend nicht verfügbar; verwenden Sie die authentifizierte Ergebniswiederherstellung, bevor Sie erneut generieren. |
| 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": ["subtitles:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.