Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Довідник API

YouTube Transcript API

Отримайте API-ключ

Редагувати YouTube трафаретний текст з таймерами та повним текстом. Автоматичні підписи вибирають за замовчуванням.

Створити запит

11-character ID з відео URL, не повний URL.

Залиште порожній, щоб спробувати en-orig, потім і повернути один трек. Або введіть один код або до 10 різні коди, відокремлені комами.

Захоплення трек 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))
Результати у відповідь HTTPавтентифікації X-API-Key

Параметри

Відправити source і video_id на рівні вершини. Параметри джерела відносяться до params. Додаткові поля можуть бути використані.

Тіло запиту

sourcestring / Обов’язково
Набір до youtube_transcript.
video_idstring / Обов’язково
11-character YouTube відео ID, такі як FUfGcZ092b0. Приймає листи, номери, низи і гіфени.
Точно 11 ЗіркиЗа замовчуванням: Не встановити
Прийнятий формат^[A-Za-z0-9_-]{11}$
paramsobject / Необов’язково
Settings для цього запиту.
За замовчуванням: {}
callback_urlstring · nullable / Необов’язково
Async і партії тільки. Public HTTPS завершена URL на порту 443, до 2,048 символів. Немає облікових даних користувача або фрагмента URL. Omit, використовуйте null або порожній рядок для повідомлення. У партії, встановивши це на кожному запиту, за межами парам.
За замовчуванням: Не встановити

Підбір підписки

params.languagestring | array / Необов’язково
Оміт для англійської (en-orig, потім en). З автоматично=true кожен код намагається його -orig відстежувати спочатку, потім запитаний код. Витратити -orig коди і авто=false залишатися точним. Запит про Арраї 1–10 відмінні мови.
За замовчуванням: en-orig → en
params.autoboolean / Необов’язково
true вибирає YouTube-генерувані підписи; false вибирає завантажувачі-відхилені підписи. Це вибирає походження підписки, не мовне виявлення або новий транскрипція.
true або falseЗа замовчуванням: true

Відповідь

Realtime повертається status: done. Читати вихід джерела на results[0]; usage.credits облік заряду.

Читання сегментів для своєчасного тексту та fullText для долучених трафаретів. початок сегмента і кінець секунди; languageCode і isAutoGenerated визначити вибраний трек.

Читати результат

Збережіть успішну відповідь JSON як response.json. Збережіть це як read-response.py і запустіть python read-response.py. Використовуються тільки Python- стандартна бібліотека і не дає нового запиту.

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

Омітувати мову, щоб віддати перевагу ен-оріг і повернутися назад, повернення однієї доріжки. За допомогою авто=true, кожен запитаний код віддає перевагу своєму треку -оріг, після чого звичайний код; явно -оріг і авто=false залишатися точним. Для того, щоб отримати доступ до інформації, необхідно надати вам інформацію про файли cookie та інші дані. languageCode визначає обраний трек; requestedLanguageCode входить, коли він відрізняється.

Для масиву мов перевіряйте поле errors, щоб дізнатися, які доріжки не вдалося отримати. Якщо не отримано жодної доріжки, запит завершується помилкою, а зарезервовані кредити повертаються. Помилка видобування даних відео або вичерпання часу запиту також призводить до збою.

Автозапчастини до true для автоматичного затискання. Набір false для завантажувачів. API ніколи не переключає джерела підпису.

API прочитав існуючі підписки YouTube; він не створює нові транограми. Відповідність за замовчуванням містить нормалізований текст JSON; Accept може вибрати звичайний текст і X-Respond-With: відмітка вибирає Markdown. languageName може бути null.

Кілька мов

Відправте масив мови для отримання треків і помилок мови. Цей приклад показує англійський доступний і іспанський 1.00.

Запит
{
  "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"
    }
  ]
}
Усі поля відповіді
ПолеОпис
sourcestringЗа запитом джерело API.
statusstringв режимі реального часу, якщо в реальному часі буде досягнуто запит.
created_atstringЧас створення відповіді в форматі ISO 8601.
usage.creditsnumberКредит, що стягується за запит, виходячи з тарифного плану.
results[0].videoIdstringВипробувано відео ID.
results[0].languageCodestringАктуально вибраний код треку підписки, наприклад, en-orig.
results[0].languageNamestring · nullableІм'я відображення мови при наявності.
results[0].requestedLanguageCodestring · optionalЗа запитом, коли він відрізняється від languageCode, наприклад, за умови, коли вибрано код.
results[0].isAutoGeneratedbooleanЧи автоматично генеруються вибрані підписи.
results[0].segmentsarrayВідрізки приймання в хронологічному порядку.
results[0].segments[].startnumberЧас запуску сегмента за секундами.
results[0].segments[].endnumberЧас закінчення терміну експлуатації в секундах.
results[0].segments[].textstringЗаписати текст.
results[0].fullTextstringВесь текст сегмента додано до транограми.
results[0].tracksarray · optionalТільки для мовних масивів. Доступні треки в порядку запиту; кожен має поля, що вказані вище.
results[0].errorsarray · optionalТільки для мовних масивів. Незліченні мови в порядку запиту. Порожня, коли кожен трек досягне успіху.
results[0].errors[].languageCodestringВимагана мова, яку не вдалося.
results[0].errors[].codestringlanguage_unavailable коли вибраний трек не існує; retrieval_failed коли він не може бути завантажений або parsed.
results[0].errors[].messagestringОпис мовної недостатності.

На полях описано типову відповідь JSON. JSON, звичайний текст і Markdown формати.

Async повертає одне надходження в роботу; повернення пакету на одну за Відео ID. Перевірити статус кожного завдання і отримати його результати за допомогою повернутих посилань.

Async & пакетний життєвий цикл

Подача повертається квитанції, не результати. Async створює одну роботу; пакет повертає окрему роботу в queries[] для кожного прийнятого запиту. Відстежуйте та отримайте кожну роботу самостійно.

Подати data.flashdata.dev; читати статус роботи та результати з api.flashdata.dev з тим же X-API-Key. Приклади базових прикладів API використовують Python і cURL.

  1. 1. Заощаджуйте роботу IDs

    Зберігати поля запиту джерела при переході на Async. Для Batch викласти кожен запит у масив запитів об'єкта JSON. Заощаджуйте кожну подану роботу ID.

    Async запит та отримання · Batch запит тіла

  2. 2. Статус на сервери

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

    pending / processing: опитування з затримкою та повагою Retry-After присутні. completed: результати fetch. failed: огляд job.error.

    Читать job.status, не статус отримання інформації.

    Перевірити статус · Python і cURL

    Статус на сервери API посилання
  3. 3. Результати Фетт

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

    Після завершення перевірте результат читати, після чого викинути 302 пам'ять URL без ключа API. Заощаджуйте JSON в межах 24 годин завершення.

    Результати розрахунків · Python і cURL · Формати відповідей

    Завантажити API

Половлення та вилучення існуючих результатів не споживають кредитні запити. Час вилучення не скасовує роботу: зберігайте ID замість подання дублікатів, які запроваджують роботу. Коди помилок та поведінка птиця.

Вебхуки завершення

Підписатися на запит

Комплекти callback_url на рівні асинхронного запиту, або всередині кожного запиту в партії, поза params. Не потрібно окремий запит на веб-візію. Realtime не надсилайте зворотні дзвінки.

Використовуйте публічний HTTPS URL на порту 443. FlashData POSTS повідомлення для кожного досягнення роботи completed або failed; подія містить посилання, не сам результат.

Acknowledge і перевірка

Повернутися 2xx після того, як багато хто приймає захід. Дублікат delivery_id, також відправлений як X-Delivery-Id. Не слідувати перенаправлення.

В'язані поставки птиця з експоненціальним відключенням, до 8 намагатися всього і в більшості 24 годин після завершення. Зберігайте опитування як падлогу.

Відкликання не відмічаються. Підтвердіть роботу ID, джерело та статус терміналу через автентифікована кінцева точка стану перед обробкою повідомлення. Доставка ID призначена для дедупації, не вистосування автентичності.

Приклад подій та полів вебхока
Ілюстрація повідомлення про завершення
{
  "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"
    }
  ]
}
ПолеОпис
delivery_idstringСтабільний ідентифікатор доставки. Відхилити повідомлення за допомогою цього значення, вона також надсилається в заголовку X-Delivery-Id.
idstringРобота ID.
sourcestringЗапит на джерело даних.
statusstringзавершено або не вдалося.
linksarrayСтатус і посилання на результат. Повідомлення не включають вміст результатів або ключ API.
links[].relstringсамо або результати.
links[].hrefstringАбсолютний менеджмент API URL; автентичний з ключем API.
links[].methodstringGET.

Повна угода вебхока та обмеження URL

Обробка файлів Bulk

Завантажте одне відео ID на рядок і створюйте роботу Bulk з джерелом: youtube_transcript. Доступні параметри застосовуються до кожного ID в файлі.

Параметри джерела: мова, авто. Поставте їх в опції при створенні завдання Bulk.

Отримати завершену колекцію як проявляється і gzip-compressed NDJSON результат частин. Джерела даних також можуть доставити деталі до хмарного сховища, встановлюючи options.result_storage при створенні завдання Bulk. Заощаджуйте прояву і частини в 24 години після завершення роботи Bulk.

Bulk обробка API · Python і cURL · Batch JSON запитів

Створіть робочий потік Bulk для цього джерела · Пауза, резюме і відновлення

Відновлення пароля

Якщо запитаний трек недоступний, перевірте метадані API transcriptLanguages і запитайте підтримуваний language/track тип явно. Повторюємо незмінний вибір, що не створить цей трек.

Перевірити наявні мови підписки з Metadata. Новий запит використовує кодові кредити; зміна треку не змінює існуючу роботу.

Для автентифікації, балансу, запиту та обмеження, використовуйте посилання на спільну помилку. Термін подачі може бути ще створено роботу; перевірити існуючу роботу перед спрацьовуванням.

Помилки й коди стану · Коли птиця · Обмеження ставок

Покроковий посібник: Виберіть мову та трек

Ціни

ПланиТарифи на користуванняза 1 000 стандартних запитівАбонентиВключені кредити за вексельний період
Оплата за використання0,50 USDБез щомісячної платиПоповнюйте за потреби
Micro0,40 USD49,00 USD / місяць1 000 кредити (50,00 USD використання API) включені
Starter0,35 USD199,00 USD / місяць4 000 кредити (200,00 USD використання API) включені
Pro0,30 USD499,00 USD / місяць10 000 кредити (500,00 USD використання API) включені
Scale0,25 USD999,00 USD / місяць20 000 кредити (1 000,00 USD використання API) включені
Business0,20 USD1 999,00 USD / місяць40 000 кредити (2 000,00 USD використання API) включені

Один тариф облікового запису. Спільні кредити для трьох продуктів. Використання, покрите включеними кредитами, повторно не оплачується.

Поточні ціни та ліміти плану