Langkau ke kandungan
MS
Dapatkan kunci API
Semak dokumentasi

Rujukan API

YouTube Transcript API

Dapatkan kunci API

GARET teks transkrip YouTube dengan timestamp dan transkrip penuh. Taksi otomatis video dipilih secara default.

Bina permintaan

Karakter 11-karakter ID dari video URL, bukan URL penuh.

Biarkan kosong untuk mencoba en-orig, kemudian en, dan kembali satu trek. Atau masukkan satu kode atau sampai 10 kode berbeda dipisahkan dengan koma.

Trek Kapsi kapsi untuk nama auto
POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_transcript",
    "video_id": "dQw4w9WgXcQ",
    "params": {
        "language": "en",
        "auto": True,
    },
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
Hasil hasil dalam respon HTTPOtentikasi X-API-Key

Parameter

Kirim source Dan video_id Di tingkat atas. Pilihan sumber termasuk dalam params. Bidang opsional dapat diabaikan.

Badan permintaan

sourcestring / Wajib
Ditetapkan untuk youtube_transcript.
video_idstring / Wajib
Karakter 11-karakter YouTube video ID, seperti FUfGcZ092b0. 280 Terima huruf, angka, underscore dan tanda hubung.
Tepatnya 11 aksaraDefault: Tidak Diset
Format yang telah Diterima^[A-Za-z0-9_-]{11}$
paramsobject / Pilihan
Settings untuk permintaan ini.
Default: {}
callback_urlstring · nullable / Pilihan
Async dan hanya kelumpuhan. Kompisi HTTPS publik URL pada port 443, hingga karakter 2,048. Kelayakan pengguna tidak ada atau fragmen URL. Omit, gunakan null atau string kosong tanpa pemberitahuan. Dalam kelompok, set ini pada setiap pertanyaan, param luar.
Default: Tidak Diset

Pemilihan kapsi kapsi kapsi

params.languagestring | array / Pilihan
Omit untuk bahasa Inggris (en-orig, kemudian en). Dengan auto=true, setiap kode mencoba trek -orignya terlebih dahulu, kemudian kode yang diminta. Kode dan auto=false akan tetap tepat. Bahasa Arrays permintaan 1–10 berbeda bahasa.
Default: en-orig → en
params.autoboolean / Pilihan
true Orang yang dipilih YouTube-Apotions -berhasil; false \"Officida pilih aplikasi uploader-provided\". Ini memilih asal usul kapsi, bukan deteksi bahasa atau transkripsi baru.
true OR atau ORANG falseDefault: true

Respons

Kembali Realtime status: done. Baca output sumber di results[0]; usage.credits Catatan catatan biaya.

Segmen baca untuk teks bertanda waktu dan fullText untuk transkrip yang bergabung. Awal dan akhir Segmen Beejing adalah detik; languageCode dan isAutoGenerated mengidentifikasi trek yang dipilih.

Baca hasilnya

Simpan respon JSON yang sukses sebagai response.json. Simpan ini sebagai read-response.py dan jalankan python read-response.py. Ini hanya menggunakan perpustakaan standar Python dan tidak membuat permintaan baru.

read-response.py
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))

Bahasa Omit untuk memilih en-orig dan kembali ke en, mengembalikan satu trek. Dengan auto=true, setiap kode yang diminta lebih menyukai trek -orignya, maka kode biasa; eksplisit -orig dan auto=false tetap tepat. Obyek Arrays mencoba setiap bahasa yang diminta dan mengembalikan trek dan kesalahan dalam urutan. languageCode mengidentifikasi trek yang dipilih; requestedLanguageCode dimasukkan ketika berbeda.

Untuk senarai bahasa, semak errors bagi mengetahui trek yang gagal. Jika tiada trek dapat diperoleh, permintaan gagal dan kredit yang diperuntukkan dipulangkan. Kegagalan pengekstrakan video dan tamat tempoh permintaan juga menyebabkan permintaan gagal.

Otomat auto default ke true untuk aplikasi otomatis. Dia menetapkan false untuk aplikasi uploader-provided. API tidak pernah beralih sumber kapsi.

API membaca sari kata YouTube yang sedia ada; ia tidak menjana transkrip baharu. Respons lalai mengandungi teks JSON ternormal; Accept boleh memilih teks biasa dan X-Respond-With: markdown memilih Markdown. languageName boleh bernilai null.

Bahasa Arab

¡Angkas bahasa untuk menerima trek dan kesalahan per-bahasa. Contoh ini menunjukkan bahasa Inggris tersedia dan bahasa Spanyol tidak tersedia.

Permintaan
{
  "source": "youtube_transcript",
  "video_id": "jNQXAC9IVRw",
  "params": {
    "language": [
      "en",
      "es"
    ],
    "auto": true
  }
}
results[0]
{
  "videoId": "jNQXAC9IVRw",
  "isAutoGenerated": true,
  "tracks": [
    {
      "videoId": "jNQXAC9IVRw",
      "languageCode": "en-orig",
      "requestedLanguageCode": "en",
      "languageName": null,
      "isAutoGenerated": true,
      "segments": [
        {
          "start": 0,
          "end": 1.5,
          "text": "Hello world."
        }
      ],
      "fullText": "Hello world."
    }
  ],
  "errors": [
    {
      "languageCode": "es",
      "code": "language_unavailable",
      "message": "Auto-generated subtitles not available for language: es"
    }
  ]
}
Semua medan respon
UkrainianKeterangan
sourcestringSumber API yang diminta.
statusstringHal ini dilakukan ketika permintaan realtime berhasil.
created_atstringWaktu penciptaan responsi kreasi dalam format ISO 8601.
usage.creditsnumberPenghargaan atas permintaan itu, berdasarkan rencanamu.
results[0].videoIdstringVideo yang diminta ID.
results[0].languageCodestringKode jalur kapsyen yang dipilih secara aktual, seperti en-orig.
results[0].languageNamestring · nullableBahasa Mandarin menampilkan nama ketika tersedia.
results[0].requestedLanguageCodestring · optionalKode yang diminta saat berbeda dengan languageCode, misalnya en ketika en-orig dipilih.
results[0].isAutoGeneratedbooleanApakah gambar - gambar yang dipilih itu secara otomatis dihasilkan.
results[0].segmentsarraySegmen-segmen kerancuan dalam urutan kronologis.
results[0].segments[].startnumberSegmen Betina memulai waktu dalam hitungan detik.
results[0].segments[].endnumberSegmen Segmen akhir waktu dalam detik.
results[0].segments[].textstringKapsi teks.
results[0].fullTextstringSemua teks segmen bergabung ke dalam transkrip.
results[0].tracksarray · optionalHanya untuk tata bahasa saja. Jalur yang tersedia dalam urutan permintaan; masing-masing memiliki ruas jalur tunggal yang tercantum di atas.
results[0].errorsarray · optionalHanya untuk tata bahasa saja. Bahasa-bahasa yang digunakan dalam urutan permintaan. Kosong ketika setiap trek berhasil.
results[0].errors[].languageCodestringBahasa yang diminta yang gagal.
results[0].errors[].codestringlanguage_unavailable ketika trek terpilih tidak ada; retrieval_failed ketika tidak dapat dimuat turun atau diurai.
results[0].errors[].messagestringKeterangan kegagalan bahasa.

Bidang-bidang di atas menggambarkan respon JSON baku. JSON, teks polos dan Markdown format.

Async 2) mengembalikan satu penerimaan kerja; batch mengembalikan satu per Video video ID. Periksa status masing-masing pekerjaan dan mendapatkan hasilnya dengan menggunakan link yang dikembalikan.

Zavous Async & batch lifecycle

Surat penyerahan mengembalikan penerimaan, bukan hasil. Async menciptakan satu pekerjaan; batch mengembalikan pekerjaan yang terpisah dalam queries[] Untuk setiap pertanyaan yang diterima. Track dan mendapatkan setiap pekerjaan secara independen.

Diserahkan ke data.flashdata.dev; baca status pekerjaan dan hasil dari api.flashdata.dev Dan X-API-Key yang sama. Contoh dasar API terkait menggunakan Python dan cURL.

  1. 1. Simpan pekerjaan IDs

    ¡Holfi mempertahankan ruas permintaan sumber ini ketika beralih ke Async. Untuk Batch, letakkan setiap permintaan di dalam array kueri dari objek JSON. Simpan setiap pekerjaan yang dikembalikan ID.

    Permintaan dan penerimaan Async · badan permintaan Batch

  2. 2. Periksa status

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing: jajak pendapat dengan penundaan dan rasa hormat Retry-After Ketika hadir. completed: Hasil tangkapan. failed: [ : ] inspeksi job.error.

    Read job.status, bukan status penerimaan.

    Periksa status · Python dan cURL

    Referensi API status Job
  3. 3. Hasil kutipan

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    Selepas selesai, sahkan akses untuk membaca hasil, kemudian ambil URL storan daripada 302 tanpa kunci API anda. Simpan JSON dalam masa 24 jam selepas selesai.

    Hasil kutip · Python dan cURL · Format respons

    Hasil pengambilan gambar referensi API

Pengejaan dan pengambilan hasil yang sudah ada tidak mengkonsumsi kredit pertanyaan. TOPN TPS tidak membatalkan pekerjaan: menjaga ID daripada mengajukan pekerjaan yang dapat ditagih. Kode galat dan perilaku coba ulang dan kode galat.

Webhook penyelesaian

Langganan per pertanyaan

**Ditetapkan* callback_url Di tingkat atas dari permintaan async, atau lema di dalam setiap pertanyaan Di dalam kelompok, di luar params. Tidak ada permintaan pendaftaran-keuskupan webhook terpisah yang diperlukan. Permintaan Realtime tidak mengirim callback.

Use a public HTTPS URL di port 443. FlashData POSTs sebuah pemberitahuan untuk setiap jangkauan pekerjaan completed OR atau ORANG failed; BARV; acara tersebut berisi tautan, bukan hasil itu sendiri.

Mengakui dan memverifikasi

AWAS 2xx Setelah menerima acara itu dengan baik. Duakan duplikasi oleh delivery_id, Dan dikirim sebagai.. X-Delivery-Id. Redirect tidak diikuti.

Pengiriman Gagal dicoba dengan pengunduran eksponensial, hingga Total percobaan 8 Zain dan paling banyak 24 jam sesudah selesai. Tetap melakukan pemungutan suara sebagai kemunduran.

Panggilan balik tidak ditandatangani. Konfirmasi pekerjaan ID, sumber dan status terminal melalui Titik akhir status tersahihkan Bekal sebelum memproses pemberitahuan. Kiriman ID adalah untuk deduksi, bukan bukti keaslian.

Contoh senam webhook peristiwa dan bidang
Pemberitahuan penyelesaian ilustrasi
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_transcript",
  "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"
    }
  ]
}
UkrainianKeterangan
delivery_idstringPengenal pengiriman yang stabil. Pemberitahuan dundaplikasi menggunakan nilai ini; juga dikirim dalam header X-Delivery-Id.
idstringYob ID.
sourcestringSumber data yang dimintakan oleh KANTOR.
statusstringGagal atau gagal.
linksarrayStatus dan hasil link. Pemakluman kata nifaks tidak termasuk konten hasil atau kunci API.
links[].relstringKegandirian atau hasil.
links[].hrefstringManajemen Absolute API URL; sahihkan dengan kunci API anda.
links[].methodstringGET.

Pembatasan kontrak penuh webhook dan URL

Pemrosesan berkas Bulk

loadloadload satu video ID per baris dan membuat pekerjaan Bulk dengan sumber: youtube_transcript. Pilihan terkongsi diterapkan untuk setiap ID dalam berkas.

Pilihan sumber: Bahasa, auto. Dia menempatkan mereka dalam pilihan ketika menciptakan pekerjaan Bulk.

Retrieve koleksi yang selesai sebagai bagian hasil NDJSON yang dikompresi secara manifes dan gzip. Sumber-sumber data juga dapat mengantarkan bagian-bagian hasil ke penyimpanan awan Anda dengan menetapkan options.result_storage ketika membuat pekerjaan Bulk. Simpan manifes dan bagian dalam 24 jam setelah seluruh pekerjaan Bulk selesai.

Pemrosesan Bulk API · Python dan cURL · Permintaan Batch JSON

Bina aliran kerja Bulk untuk sumber ini · Dikaku, lanjutkan dan pulihkan

Pemulihan Galat

Jika trek yang diminta tidak tersedia, periksalah jenis APIXQ's transcriptLanguages dan minta jenis language/track yang didukung secara eksplisit. Mengulang pilihan yang tidak tersedia tidak berubah tidak akan membuat trek itu.

Periksa bahasa kapsi yang tersedia dengan Metadata. Sebuah permintaan baru menggunakan kredit pertanyaan; mengubah sebuah trek tidak memodifikasi pekerjaan yang ada.

Untuk autentikasi, keseimbangan, permintaan-format dan tingkat-batas kegagalan, gunakan referensi kesalahan bersama. Pengerahan surat perintah mungkin masih menciptakan pekerjaan; memeriksa pekerjaan yang sudah ada sebelum mencoba lagi.

Ralat dan kod status · Bila hendak mencoba lagi · Batasan kadar laklak

Panduan langkah demi langkah: Pilih bahasa dan trek transkrip

Harga

RencanaKadar penggunaan terminologibagi setiap 1,000 permintaan standardLanggananKredit yang disertakan per perioda penagihan
Bayar mengikut penggunaanUSD 0.50Tiada yuran bulananTambah nilai apabila perlu
MicroUSD 0.40USD 49.00 / month1,000 Kerugian (USD 50.00 WOVE API penggunaan ) disertakan
StarterUSD 0.35USD 199.00 / month4,000 Kerugian (USD 200.00 WOVE API penggunaan ) disertakan
ProUSD 0.30USD 499.00 / month10,000 Kerugian (USD 500.00 WOVE API penggunaan ) disertakan
ScaleUSD 0.25USD 999.00 / month20,000 Kerugian (USD 1,000.00 WOVE API penggunaan ) disertakan
BusinessUSD 0.20USD 1,999.00 / month40,000 Kerugian (USD 2,000.00 WOVE API penggunaan ) disertakan

Satu pelan akaun. Kredit dikongsi merentas ketiga-tiga produk. Penggunaan yang diliputi kredit pelan tidak dikenakan caj sekali lagi.

Harga dasar dan batas rencana