Chuyển đến nội dung
VI
Lấy khóa API
Duyệt tài liệu

Tham chiếu API

YouTube Transcript API

Lấy khóa API

Lấy lại YouTube Viết lại văn bản bằng nhãn thời gian và bản ghi chép đầy đủ. Tùy chọn tự động

Tạo yêu cầu

Hạt 11- Hồ sơ. ID từ video URLkhông phải là toàn bộ URL.

Để trống để thử en-orig, sau đó en, và trở lại một dấu vết. Hoặc nhập một mã số hoặc lên đến 10 Mã riêng biệt được tách ra bởi Dấu phẩy.

Theo dõi độ xoay 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))
Kết quả trong phản ứng HTTPX-API-Key Xác thực

Tham số

Gởi source và video_id Ở tầng cao nhất. Tùy chọn nguồn thuộc về params. Có thể bỏ qua trường tùy chọn.

Nội dung yêu cầu

sourcestring / Bắt buộc
Thiết lập youtube_transcript.
video_idstring / Bắt buộc
Hạt 11- Hồ sơ. YouTube video IDNhư FUfGcZ092b0. Chấp nhận chữ cái, số, điểm nhấn và dấu gạch nối.
Chính xác 11 Ký tựMặc định: Chưa đặt
Định dạng đã chấp nhận^[A-Za-z0-9_-]{11}$
paramsobject / Không bắt buộc
Settings cho yêu cầu này.
Mặc định: {}
callback_urlstring · nullable / Không bắt buộc
Async và chỉ một mẻ. Chung HTTPS hoàn tất URL trên cổng 443Đến 2,048 các nhân vật. Không có phân khúc người dùng hay URL. Omit, dùng null hoặc chuỗi rỗng không cho thông báo nào. Trong một mẻ, đặt nó trên mỗi câu hỏi, bên ngoài các tham số.
Mặc định: Chưa đặt

Chọn độ xoay

params.languagestring | array / Không bắt buộc
Omit cho tiếng Anh (en-oig, sau đó en). Với tự động =true, mỗi mã cố gắng -oig theo dõi trước, sau đó là mã đã yêu cầu. Explicit -ig mã và tự động =false Giữ nguyên vị trí. Yêu cầu Array 1–10 Những ngôn ngữ khác nhau.
Mặc định: en-orig → en
params.autoboolean / Không bắt buộc
true lựa chọn YouTube-Các phụ đề được tạo ra; false chọn những phụ đề tải lên. Tùy chọn này chọn nguồn gốc chú thích, không phải phát hiện ngôn ngữ hay chuyển đổi mới.
true hay falseMặc định: true

Phản hồi

Realtime trở về status: done. Đọc kết xuất nguồn tại results[0]; usage.credits Ghi lại tội danh.

Đọc các đoạn văn cho đoạn văn đã nhãn thời gian và fullText cho bản ghi âm. Đoạn phim bắt đầu và kết thúc là giây; languageCode và isAutoGenerated Xác định vị trí.

Đọc kết quả

Cứu người thành công JSON trả lời response.json. Lưu cái này vào read-response.py và chạy python read-response.py. Nó chỉ dùng thôi. PythonThư viện thông thường và không có yêu cầu mới.

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))

Ngôn ngữ Omit tốt hơn en-orig và rơi trở lại en, trở lại một đường ray. Với tự động =true., mỗi yêu cầu mã thích theo dõi -ig của nó, sau đó mã đơn giản; rõ ràng -orig và tự động =false Giữ nguyên vị trí. Arrays thử mọi ngôn ngữ đã yêu cầu, rồi trả lại dấu vết và lỗi theo thứ tự. languageCode xác định đường dẫn đã chọn; requestedLanguageCode có nghĩa là khi có sự khác biệt.

Với mảng ngôn ngữ, hãy kiểm tra errors để biết các bản phụ đề bị lỗi. Nếu không lấy được bản phụ đề nào, yêu cầu sẽ thất bại và số tín dụng đã giữ sẽ được hoàn lại. Lỗi trích xuất video hoặc yêu cầu hết thời gian chờ cũng làm yêu cầu thất bại.

mặc định tự động cho true cho các phụ đề tự động. Đặt false để tải lên chú thích. API không bao giờ chuyển đổi các nguồn tiêu đề.

Hạt API đã đọc YouTube đánh giá: nó không tạo bản ghi mới. Đáp ứng mặc định chứa bình thường JSON Văn bản; Accept có thể chọn đoạn đơn giản và X-Respond-With: Đánh dấu các phần chọn Markdown. languageName có thể null.

Nhiều ngôn ngữ

Gửi một dãy ngôn ngữ để nhận dấu vết và lỗi per-language. Ví dụ này cho thấy không có tiếng Anh và tiếng Tây Ban Nha.

Yêu cầu
{
  "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"
    }
  ]
}
Tất cả các trường đáp ứng
Tìm kiếmMô tả
sourcestringNguồn API đã yêu cầu.
statusstringhoàn thành khi yêu cầu thời gian thực thành công.
created_atstringThời gian tạo ra đáp ứng trong ISO 8601 Định dạng.
usage.creditsnumberCác nguồn tin cho yêu cầu, dựa trên kế hoạch của anh.
results[0].videoIdstringVideo đã yêu cầu ID.
results[0].languageCodestringPhần mềm theo dõi đã chọn đích danh, như en-oig.
results[0].languageNamestring · nullableTên hiển thị ngôn ngữ nếu có.
results[0].requestedLanguageCodestring · optionalMã đã yêu cầu khi nó khác với languageCodeVí dụ như en khi en-orig được chọn.
results[0].isAutoGeneratedbooleanCó tạo ra tự động phụ đề đã chọn hay không.
results[0].segmentsarrayPhần mở rộng theo thứ tự thời gian.
results[0].segments[].startnumberĐoạn phim sẽ bắt đầu trong vài giây.
results[0].segments[].endnumberĐoạn kết thúc thời gian trong vài giây.
results[0].segments[].textstringVăn bản liên kết.
results[0].fullTextstringTất cả đoạn văn đoạn thẳng vào bản ghi chép.
results[0].tracksarray · optionalChỉ cho các dãy ngôn ngữ. Các đường ray sẵn sàng theo thứ tự yêu cầu; mỗi trường đơn có danh sách trên.
results[0].errorsarray · optionalChỉ cho các dãy ngôn ngữ. Lỗi ngôn ngữ theo thứ tự yêu cầu. Trống rỗng khi mọi dấu vết đều thành công.
results[0].errors[].languageCodestringNgôn ngữ đã yêu cầu bị lỗi.
results[0].errors[].codestringlanguage_unavailable khi đường dẫn đã chọn không tồn tại; retrieval_failed không thể tải hoặc phân tích nó.
results[0].errors[].messagestringMô tả lỗi ngôn ngữ.

Các trường trên mô tả giá trị mặc định JSON Trả lời đi. JSON, văn bản đơn giản và Markdown Định dạng.

Async trả lại một biên nhận công việc; mỗi viên trả lại một cái Video ID. Kiểm tra tình trạng của mỗi công việc và lấy kết quả của nó bằng liên kết đã quay về.

Async & mẻ xe đạp cứu hộ

Không có kết quả, không có gì. Async tạo ra một công việc; một mẻ cung cấp một công việc riêng biệt trong queries[] Cho mỗi yêu cầu được chấp nhận. Theo dõi và lấy lại mỗi công việc một cách độc lập.

Gởi tới data.flashdata.dev; đọc tình trạng công việc và kết quả từ api.flashdata.dev với cùng một X-API-Key. Liên kết API Các ví dụ cơ bản dùng Python và cURL.

  1. 1. Lưu công việc IDs

    Giữ trường yêu cầu này khi chuyển sang Async. Đối với Batch, đặt mỗi yêu cầu vào trong dãy các câu hỏi của một đối tượng JSON. Lưu mọi công việc trở về ID.

    Async yêu cầu và biên lai · Batch yêu cầu cơ thể

  2. 2. Kiểm tra trạng thái

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

    pending / processing: cuộc thăm dò với một sự chậm trễ và kính trọng Retry-After khi có mặt. completed: Tìm kết quả đi. failed: thanh tra job.error.

    Đọc job.status, không phải là địa chỉ biên nhận.

    Kiểm tra trạng thái %s Python và cURL

    Trạng thái công việc API tham chiếu
  3. 3. Lấy kết quả

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

    Sau khi hoàn thành, xác thực kết quả đọc, sau đó lấy các 302 kho URL Không có bạn API Chìa khóa. Cứu lấy JSON bên trong 24 Giờ hoàn thành.

    Lấy kết quả l· Python và cURL · Định dạng phản hồi

    Tải về kết quả API tham chiếu

Làm ô nhiễm và thu thập kết quả hiện có không làm mất tín dụng truy vấn. Thời hạn bầu cử không hủy bỏ công việc: Giữ nó ID Thay vì nộp bản sao. Lỗi mã và hành vi thử lại.

Webhook khi hoàn tất

Đăng ký mỗi yêu cầu

Đặt callback_url ở cấp độ cao nhất của một yêu cầu đặc biệt, hoặc bên trong mỗi truy vấn trong một mẻ đá, bên ngoài params. Không cần yêu cầu duy trì webhoook riêng biệt. Yêu cầu Realtime không gửi hồi âm.

Dùng công chúng HTTPS URL trên cổng 443. FlashData PST một thông báo cho mỗi công việc với tới completed hay failed; sự kiện này chứa các liên kết, chứ không phải kết quả chính nó.

Xác nhận và xác nhận

Trả lại 2xx sau khi chấp nhận sự kiện này. Bị hủy bỏ bởi delivery_id, cũng gửi như X-Delivery-Id. Không theo dõi sự chuyển hướng.

Việc giao hàng lại thất bại thử với số mũ ngược lại, lên đến 8 Tổng cố gắng và nhiều nhất Giờ 24 sau khi hoàn tất. Tiếp tục bỏ phiếu như một sự phản đối.

Cuộc gọi lại không được ký. Xác nhận công việc ID, nguồn và thiết bị cuối thông qua các máy chủ Điểm kết thúc trạng thái xác thực trước khi xử lý thông báo. Giao hàng. ID không phải bằng chứng về tính xác thực.

Sự kiện webhook và các trường mẫu
Thông báo hoàn tất tưởng tượng
{
  "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"
    }
  ]
}
Tìm kiếmMô tả
delivery_idstringBộ nhận dạng giao hàng ổn định. Thông báo hủy bỏ sử dụng giá trị này; nó cũng được gửi vào X-Delivery-Id Đầu trang.
idstringJob ID.
sourcestringĐã yêu cầu nguồn dữ liệu.
statusstringhoàn thành hoặc thất bại.
linksarrayTình trạng và kết quả liên kết. Thông báo không bao gồm nội dung hoặc phím API.
links[].relstringbản thân hoặc kết quả.
links[].hrefstringQuản lý tuyệt đối API URL; Xác thực với của bạn API Chìa khóa.
links[].methodstringGET.

Hợp đồng mạng và URL hạn chế

Bulk xử lý tập tin

Tải lên một video ID mỗi dòng và tạo ra Bulk công việc có mã nguồn: youtube_transcript. Tùy chọn chia sẻ được áp dụng cho mỗi tùy chọn ID Trong hồ sơ.

Tùy chọn nguồn: ngôn ngữ, tự động. Đặt chúng vào các tùy chọn khi tạo ra Bulk Công việc.

Thu thập tập hợp hoàn chỉnh như một bản liệt kê và gzip-compress NDJSON kết quả là các bộ phận. Nguồn dữ liệu cũng có thể cung cấp các phần kết quả đến đám mây của bạn lưu trữ bằng cách thiết lập options.result_storage khi tạo ra Bulk Công việc. Lưu danh sách và các phần bên trong 24 Hàng giờ sau toàn bộ Bulk Công việc hoàn tất.

Bulk xử lý API · Python và cURL · Batch JSON yêu cầu

Xây dựng a Bulk dòng làm việc cho nguồn này · Tạm dừng, tiếp tục và phục hồi

Đang phục hồi lỗi

Nếu không sẵn sàng, kiểm tra siêu dữ liệu APICủa transcriptLanguages và yêu cầu hỗ trợ language/track Loại rõ ràng. Lặp lại sự lựa chọn không thay đổi sẽ không tạo đường đó.

Kiểm tra các ngôn ngữ đầu đề có sẵn với siêu dữ liệu. Một yêu cầu mới sử dụng thẻ truy vấn; thay đổi đường dẫn không thay đổi công việc đã có.

Để xác thực, số dư, lỗi định vị và tỷ lệ thất bại, hãy dùng tham chiếu lỗi được chia sẻ. Thời hạn nộp có lẽ đã tạo một công việc; kiểm tra công việc đã có trước khi thử lại.

Lỗi và mã trạng thái · Khi nào cần thử lại · Giới hạn

Hướng dẫn từng bước một: Chọn một trình soạn thảo ngôn ngữ và theo dõi

Giá

Gói dịch vụĐơn giá sử dụngcho mỗi 1.000 yêu cầu tiêu chuẩnĐăng kýBao gồm cả tín dụng mỗi thời gian thanh toán
Trả theo mức sử dụng0,50 US$Không có phí hàng thángNạp thêm khi cần
Micro0,40 US$49,00 US$ / tháng1.000 Tín dụng (50,00 US$ Tháng Ba API sử dụng) bao gồm
Starter0,35 US$199,00 US$ / tháng4.000 Tín dụng (200,00 US$ Tháng Ba API sử dụng) bao gồm
Pro0,30 US$499,00 US$ / tháng10.000 Tín dụng (500,00 US$ Tháng Ba API sử dụng) bao gồm
Scale0,25 US$999,00 US$ / tháng20.000 Tín dụng (1.000,00 US$ Tháng Ba API sử dụng) bao gồm
Business0,20 US$1.999,00 US$ / tháng40.000 Tín dụng (2.000,00 US$ Tháng Ba API sử dụng) bao gồm

Một gói tài khoản. Tín dụng dùng chung cho cả ba sản phẩm. Mức sử dụng được tín dụng trong gói chi trả sẽ không bị tính phí lần nữa.

Giá cả hiện tại và giới hạn kế hoạch