Dokumentation durchsuchen
API-Referenz
YouTube Captions API
Abrufen von YouTube-Beschriftungen als Zeitstempeltext und vollständiges Transkript. Von Uploadern bereitgestellte Beschriftungen werden standardmäßig ausgewählt.
Anfrage erstellen
Die 11 Zeichen lange ID aus der Video-URL, nicht die vollständige URL.
Leer lassen, um zuerst en-orig und danach en zu versuchen und eine Spur zurückzugeben. Alternativ einen bis 10 verschiedene Codes durch Kommas getrennt eingeben.
https://data.flashdata.dev/v1/queries/realtimeParameter
Senden source und video_id auf der obersten Ebene. Source-Optionen gehören in params. Optionale Felder können entfallen.
Anfrageinhalt
sourcestring / Erforderlich- Setzen Sie auf youtube_captions.
video_idstring / Erforderlich- Das 11-Charakter YouTube Video ID, wie FUfGcZ092b0. Akzeptiert Buchstaben, Zahlen, Unterstriche und Bindestriche.Genau 11 ZeichenStandard:
Nicht eingestelltAkzeptiertes Format
^[A-Za-z0-9_-]{11}$ paramsobject / Optional- Settings für diese Anfrage.Standard:
{} callback_urlstring · nullable / Optional- Async und Batch nur. Öffentliche HTTPS Fertigstellung URL auf Port 443, bis zu 2,048 Zeichen. Keine Benutzeranmeldeinformationen oder URL-Fragment. Verwenden Sie null oder einen leeren String für keine Benachrichtigung. Setzen Sie dies in einem Batch auf jede Abfrage, außerhalb von Params.Standard:
Nicht eingestellt
Auswahl der Beschriftung
params.languagestring | array / Optional- Weglassen für Englisch (en-orig, dann en). Mit auto=true versucht jeder Code zuerst seine -Orig-Spur, dann den angeforderten Code. Explizite -orig-Codes und auto=false bleiben genau. Arrays fordern 1–10 unterschiedliche Sprachen an.Standard:
en-orig → en params.autoboolean / Optional- true wählt YouTube-generierte Untertitel aus; false wählt von Uploadern bereitgestellte Untertitel aus. Dies wählt den Ursprung der Beschriftung aus, nicht die Spracherkennung oder neue Transkription.
trueoderfalseStandard:false
Antwort
Realtime zurück status: done. Lesen Sie den Source Output auf results[0]; usage.credits die Ladung aufzeichnet.
Lesen Sie Segmente für Beschriftungstext mit start/end-Zeiten in Sekunden und fullText für zusammengefügten Text. languageCode und isAutoGenerated melden den ausgewählten Track.
Lesen Sie das Ergebnis
Speichern Sie die erfolgreiche JSON-Antwort als response.json. Speichern Sie dies als read-response.py und führen Sie Python read-response.py aus. Es verwendet nur die Standardbibliothek von Python und stellt keine neue Anforderung.
import json
from pathlib import Path
response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
print("[]")
raise SystemExit(0)
result = response["results"][0]
output = {
"tracks": result.get("tracks", [result]),
"errors": result.get("errors", []),
}
print(json.dumps(output, ensure_ascii=False, indent=2))Lassen Sie die Sprache weg, um en-orig zu bevorzugen, und greifen Sie auf en zurück, wobei Sie einen Track zurückgeben. Mit auto=true bevorzugt jeder angeforderte Code seine -orig-Spur, dann den einfachen Code; explizit -orig und auto=false bleiben genau. Arrays versuchen jede angeforderte Sprache und geben Spuren und Fehler in der Reihenfolge zurück. languageCode identifiziert den ausgewählten Track; requestedLanguageCode ist enthalten, wenn er sich unterscheidet.
Prüfen Sie bei Spracharrays errors, um fehlgeschlagene Spuren zu erkennen. Wird keine Spur abgerufen, schlägt die Anfrage fehl und reservierte Credits werden erstattet. Auch Fehler bei der Videoextraktion oder eine Zeitüberschreitung führen zum Fehlschlag.
Auto-Standards zu false für von Uploadern bereitgestellte Bildunterschriften. Setzen Sie true für automatische Beschriftungen. Der API schaltet niemals Beschriftungsquellen aus.
Der API liest vorhandene YouTube-Beschriftungen; er erzeugt keine neuen Transkripte. Die Standardantwort enthält normalisierte JSON-Segmente; Accept kann Klartext auswählen und X-Respond-With: Markdown wählt Markdown aus. languageName kann null sein; Segment-Timings bleiben erhalten.
Mehrere Sprachen
Senden Sie ein Sprach-Array, um Tracks und pro-Sprach-Fehler zu erhalten. Dieses Beispiel zeigt Englisch verfügbar und Spanisch nicht verfügbar.
{
"source": "youtube_captions",
"video_id": "jNQXAC9IVRw",
"params": {
"language": [
"en",
"es"
],
"auto": false
}
}{
"videoId": "jNQXAC9IVRw",
"isAutoGenerated": false,
"tracks": [
{
"videoId": "jNQXAC9IVRw",
"languageCode": "en",
"languageName": null,
"isAutoGenerated": false,
"segments": [
{
"start": 0,
"end": 1.5,
"text": "Hello world."
}
],
"fullText": "Hello world."
}
],
"errors": [
{
"languageCode": "es",
"code": "language_unavailable",
"message": "Uploader-provided subtitles not available for language: es"
}
]
}Alle Antwortfelder
| Feld | Beschreibung |
|---|---|
sourcestring | Die angeforderte API-Quelle. |
statusstring | Dies geschieht, wenn die Echtzeitanforderung erfolgreich ist. |
created_atstring | Antworterstellungszeit im Format ISO 8601. |
usage.creditsnumber | Credits, die für die anfrage berechnet werden, basierend auf ihrem plan. |
results[0].videoIdstring | Das angeforderte Video ID. |
results[0].languageCodestring | Tatsächlich ausgewählter Beschriftungstrackcode, wie z. B. en-orig. |
results[0].languageNamestring · nullable | Name der Sprache, wenn verfügbar. |
results[0].requestedLanguageCodestring · optional | Der angeforderte Code, wenn er sich von languageCode unterscheidet, z. B. wenn en-orig ausgewählt wurde. |
results[0].isAutoGeneratedboolean | Ob die ausgewählten Untertitel automatisch generiert wurden. |
results[0].segmentsarray | Beschriftungssegmente in chronologischer Reihenfolge. |
results[0].segments[].startnumber | Segmentstartzeit in Sekunden. |
results[0].segments[].endnumber | Segment-Endzeit in Sekunden. |
results[0].segments[].textstring | Text der Bildunterschrift. |
results[0].fullTextstring | Alle Segmenttexte wurden in einem Transkript zusammengefügt. |
results[0].tracksarray · optional | Nur für Spracharrays. Verfügbare Tracks in Request-Reihenfolge; jeder hat die oben aufgeführten Einzelspurfelder. |
results[0].errorsarray · optional | Nur für Spracharrays. Fehlgeschlagene Sprachen in der Reihenfolge der Anfrage. Leer, wenn jeder Track erfolgreich ist. |
results[0].errors[].languageCodestring | Die angeforderte Sprache, die fehlgeschlagen ist. |
results[0].errors[].codestring | language_unavailable, wenn der ausgewählte Track nicht existiert; retrieval_failed, wenn er nicht heruntergeladen oder analysiert werden konnte. |
results[0].errors[].messagestring | Beschreibung des Sprachversagens. |
Die obigen Felder beschreiben die Standardantwort von JSON. JSON, Klartext und Markdown Formate.
Async gibt eine Auftragsbestätigung zurück; Batch gibt eine pro Auftrag zurück Video ID. Überprüfen Sie den Status jedes Jobs und rufen Sie seine Ergebnisse mit den zurückgegebenen Links ab.
Async & Batch-Lebenszyklus
Die Einreichung gibt eine Quittung zurück, keine Ergebnisse. Async erstellt einen Job; batch gibt einen separaten Job in queries[] Für jede akzeptierte Abfrage. Verfolgen und Abrufen jedes Jobs unabhängig.
Einreichen von data.flashdata.dev; lesen Sie den Jobstatus und die Ergebnisse von api.flashdata.dev mit dem gleichen X-API-Key. Die verknüpften API-Grundlagenbeispiele verwenden Python und cURL.
1. Speichern Sie den Job IDs
Behalten Sie die Anforderungsfelder dieser Quelle bei, wenn Sie zu Async wechseln. Legen Sie für Batch jede Anfrage in das Abfrage-Array eines JSON-Objekts. Speichern Sie jeden zurückgegebenen Job ID.
2. Kontrollstatus
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: Umfrage mit Verzögerung und RespektRetry-Afterwenn vorhanden.completed: Ergebnisse holen.failed: Inspektionjob.error.Lesen Sie job.status, nicht den Status der Eingangsbestätigung.
Stellenstatus API-Referenz3. Abrufergebnisse
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsNach Abschluss authentifizieren Sie das gelesene Ergebnis und holen dann den 302-Speicher URL ohne Ihren API-Schlüssel ab. Speichern Sie den JSON innerhalb von 24 Stunden nach Fertigstellung.
Ergebnisse abrufen · Python und cURL · Antwortformate
Ergebnis Download API Referenz
Das Abfragen und Abrufen vorhandener Ergebnisse verbraucht keine Abfragegutschriften. Ein Polling-Timeout storniert den Job nicht: Behalten Sie seinen ID, anstatt doppelt abrechenbare Arbeit einzureichen. Fehlercodes und Wiederholverhalten.
Webhooks bei Abschluss
Abonnieren pro Abfrage
Setz callback_url auf der obersten Ebene einer async-Anfrage oder In jeder Abfrage in einer Charge, außen params. Es ist keine separate Webhook-Registrierungsanforderung erforderlich. Realtime-Anfragen senden keine Rückrufe.
Verwenden Sie ein öffentliches HTTPS URL auf Port 443. FlashData POST eine Benachrichtigung für jeden Job, der erreicht wird completed oder failed; Das Ereignis enthält Links, nicht das Ergebnis selbst.
Bestätigung und Überprüfung
Rückkehr 2xx nach dauerhafter Annahme des Ereignisses. Dedupliziert von delivery_id, auch gesendet als X-Delivery-Id. Redirects werden nicht befolgt.
Fehlgeschlagene Lieferungen wiederholen sich mit exponentiellem Backoff, bis zu 8 Versuche insgesamt und höchstens 24 Stunden nach Fertigstellung. Führen Sie Umfragen als Rückfall.
Callbacks sind nicht signiert. Bestätigen Sie den Job ID, den Quell- und Terminalstatus durch die authentifizierter Statusendpunkt vor der Bearbeitung der Benachrichtigung. Die Lieferung ID dient der Deduplizierung, nicht dem Nachweis der Echtheit.
Beispiel Webhook Event und Felder
{
"delivery_id": "completion:job_example0001",
"id": "job_example0001",
"source": "youtube_captions",
"status": "completed",
"links": [
{
"rel": "self",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001",
"method": "GET"
},
{
"rel": "results",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
"method": "GET"
}
]
}| Feld | Beschreibung |
|---|---|
delivery_idstring | Stabile Lieferkennung. Deduplizieren Sie Benachrichtigungen mit diesem Wert; es wird auch im X-Delivery-Id-Header gesendet. |
idstring | Job ID. |
sourcestring | Angeforderte Datenquelle. |
statusstring | vervollständigt oder fehlgeschlagen. |
linksarray | Status- und Ergebnislinks. Benachrichtigungen enthalten keinen Ergebnisinhalt oder einen API-Schlüssel. |
links[].relstring | Selbst oder Ergebnisse. |
links[].hrefstring | Absolute Management API URL; Authentifizierung mit Ihrem API-Schlüssel. |
links[].methodstring | GET. |
Bulk Dateiverarbeitung
Laden Sie ein Video ID pro Zeile hoch und erstellen Sie den Job Bulk mit der Quelle: youtube_captions. Gemeinsame Optionen gelten für jede ID in der Datei.
Quellenoptionen: Sprache, Auto. Setzen Sie sie in Optionen, wenn Sie den Bulk-Job erstellen.
Holen Sie die fertige Sammlung als manifeste und gzip-komprimierte NDJSON Ergebnisteile ab. Datenquellen können auch Ergebnisteile in Ihren Cloud-Speicher liefern, indem Sie beim Erstellen des Bulk-Auftrags options.result_storage festlegen. Speichern Sie das Manifest und die Teile innerhalb von 24 Stunden nach Abschluss des gesamten Bulk-Auftrags.
Bulk Verarbeitung API · Python und cURL · Batch JSON Anfragen
Erstellen Sie einen Bulk-Workflow für diese Quelle · Pause, Wiederaufnahme und Wiederherstellung
Fehlerbehebung
Ein video kann automatische beschriftungen haben, aber keine manuelle spur, oder es fehlt ihre gewünschte sprache. Überprüfen Sie die Verfügbarkeit von Beschriftungen mit Metadaten und wählen Sie die Sprache und den Ursprung bewusst vor einer neuen Einreichung aus.
Verfügbare Beschriftungssprachen mit Metadaten überprüfen. Eine neue Anforderung verwendet Abfrage-Credits; das Ändern eines Tracks ändert keinen bestehenden Job.
Für Authentifizierungs-, Balance-, Request-Format- und Rate-Limit-Fehler verwenden Sie die gemeinsame Fehlerreferenz. Ein Einreichungs-Timeout hat möglicherweise immer noch einen Job erstellt; Überprüfen Sie die vorhandene Arbeit, bevor Sie erneut versuchen.
Fehler und Statuscodes · Wann man es erneut versucht · Zinsbindungen
Schritt-für-Schritt Anleitung: Abrufen von Zeitstempel-Beschriftungen
Preise
| Pläne | Nutzungssätzepro 1.000 Standardanfragen | Abonnements | Inklusive Credits pro Abrechnungszeitraum |
|---|---|---|---|
| Nutzungsabhängige Zahlung | 0,50 $ | Keine Monatsgebühr | Bei Bedarf aufladen |
| Micro | 0,40 $ | 49,00 $ / Monat | 1.000 Credits (50,00 $ von API Nutzung) enthalten |
| Starter | 0,35 $ | 199,00 $ / Monat | 4.000 Credits (200,00 $ von API Nutzung) enthalten |
| Pro | 0,30 $ | 499,00 $ / Monat | 10.000 Credits (500,00 $ von API Nutzung) enthalten |
| Scale | 0,25 $ | 999,00 $ / Monat | 20.000 Credits (1.000,00 $ von API Nutzung) enthalten |
| Business | 0,20 $ | 1.999,00 $ / Monat | 40.000 Credits (2.000,00 $ von API Nutzung) enthalten |
Ein Kontotarif. Gemeinsames Guthaben für alle drei Produkte. Durch enthaltenes Guthaben gedeckte Nutzung wird nicht erneut berechnet.
Aktuelle Preise und Planlimits