Gespeichertes Ergebnis einer Untertitelaktion lesen

POST https://api.voicecheap.ai/v1/actions/subtitles_result_get

​

Authentifizierung und Berechtigungen

​

Parameter

{
  "type": "object",
  "properties": {
    "resultId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "includeContent": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": ["resultId"],
  "additionalProperties": false
}

​

Anfragebeispiele

curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_result_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b","includeContent":true}'

const input = {
  resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
  includeContent: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_result_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);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/subtitles_result_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b", "includeContent": True},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

​

Antwort

{
  "data": {
    "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
    "operation": "captions_transcribe",
    "createdAt": 1792152000000,
    "fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
    "byteLength": 190,
    "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",
    "result": {
      "words": [
        {
          "text": "Hello",
          "startMs": 0,
          "endMs": 500,
          "speakerId": "speaker_0"
        },
        {
          "text": "world.",
          "startMs": 500,
          "endMs": 1500,
          "speakerId": "speaker_0"
        }
      ],
      "detectedLanguage": "en",
      "durationSeconds": 60
    }
  }
}

​

Ergebnisfelder

​

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.
• resultId ist eine UUID aus einer abgeschlossenen Generierungsreferenz oder aus result_list dieser Domäne. Sie unterscheidet sich von der requestId der Aktion und der historyId des Webtools.
• Ergebnisse gehören dem authentifizierten ausführenden Benutzer und dem Berechtigungsbereich. Ein subtitles-Ergebnis kann nicht über transcription-Aktionen gelesen werden und umgekehrt.
• Das vollständige gespeicherte JSON wird im Ruhezustand verschlüsselt und unabhängig vom begrenzten Cache für die regelmäßige Aktionsabfrage aufbewahrt. Der Abruf erfordert weiterhin eine Authentifizierung; es wird keine öffentliche JSON-URL für Transkripte oder Untertitel ausgegeben.
• Diese Aktionen rufen bestehende Ausgaben ab, erzeugen keine Medien und verbrauchen kein tägliches Kontingent. Jeder erfolgreiche Abruf verbraucht weiterhin einen monatlichen Integrationsaufruf.
• Metadaten mit dem Status pending bedeuten, dass die dauerhafte Speicherung der Ausgabe wiederhergestellt werden muss. Beim Lesen des Inhalts oder Herunterladen wird versucht, ein bereits gespeichertes verschlüsseltes Objekt wiederherzustellen; prüfen Sie dies, bevor Sie eine weitere Generierung starten.
• includeContent ist standardmäßig false. true entschlüsselt das vollständige generierte JSON und gibt es unter result zurück. Dieses Beispiel zeigt die Form, die den Inhalt zurückgibt.
• Die Struktur des verschachtelten Ergebnisses folgt seinem ursprünglichen Vorgang. Transkriptionsausgaben enthalten Transkripttext, Untertitelausgaben können SRT-/gerenderte Videodaten enthalten, und Texteinblendungen enthalten Worttext, startMs/endMs, einen speakerId-Wert, der null sein kann, und durationSeconds.

​

Nutzung

​

Fehler

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["subtitles:read"]
  }
}