Обзор документации
Справочник API
YouTube Captions API
Восстановите подписи YouTube в виде текста с отметкой времени и полной транскрипции. Подписи, предоставленные загрузчиком, выбираются по умолчанию.
Создать запрос
11-символ ID из видео URL, а не полный URL.
Оставьте пустой, чтобы попробовать эн-ориг, затем эн, и верните один трек. Или введите один код или до 10 различные коды, разделенные запятыми.
https://data.flashdata.dev/v1/queries/realtimeПараметры
Отправить source и video_id на высшем уровне. Варианты источника принадлежат params. Факультативные поля можно опустить.
Тело запроса
sourcestring / Обязательно- Настройка на youtube_captions.
video_idstring / Обязательно- 11-символ YouTube видео ID, например FUfGcZ092b0. Принимает буквы, цифры, подчеркивания и дефисы.Точно. 11 персонажиПо умолчанию:
Не установленПринятый формат
^[A-Za-z0-9_-]{11}$ paramsobject / Необязательно- Settings для этого запроса.По умолчанию:
{} callback_urlstring · nullable / Необязательно- Async и пакетные. Публичный HTTPS завершает URL на порте 443, вплоть до символов 2,048. Никаких учетных данных пользователя или фрагмента URL. Omit, используйте null или пустую строку без уведомления. В партии, установите это на каждый запрос, вне парамов.По умолчанию:
Не установлен
Выбор подписей
params.languagestring | array / Необязательно- Английский язык (en-orig, далее en). С auto=true каждый код сначала пробует свой -orig трек, затем запрашиваемый код. Явные коды -orig и auto=false остаются точными. Arrays запрашивает разные языки 1–10.По умолчанию:
en-orig → en params.autoboolean / Необязательно- true выбирает подписи, созданные YouTube; false выбирает подписи, предоставленные загрузчиком. При этом выбирается происхождение подписи, а не обнаружение языка или новая транскрипция.
trueилиfalseПо умолчанию:false
Ответ
Realtime возвращается status: done. Прочитайте исходный текст на results[0]; usage.credits Записывает обвинение.
Прочитайте сегменты для текста подписи с start/end раз в секундах и fullText для объединенного текста. languageCode и isAutoGenerated сообщают выбранный трек.
Прочитайте результат
Сохраните успешный ответ JSON как response.json. Сохраните это как read-response.py и запустите python read-response.py. Он использует только стандартную библиотеку Python и не делает никаких новых запросов.
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))Откажитесь от языка, чтобы предпочесть эн-ориг и вернуться к эн, вернув один трек. С auto=true каждый запрашиваемый код предпочитает свой -orig трек, а затем простой код; явный -orig и auto=false остаются точными. Решетки проверяют каждый запрошенный язык и возвращают треки и ошибки в порядке. languageCode идентифицирует выбранный трек; requestedLanguageCode включен, когда он отличается.
Для массива языков проверьте поле errors, чтобы узнать, какие дорожки не удалось получить. Если не получено ни одной дорожки, запрос завершается ошибкой, а зарезервированные кредиты возвращаются. Ошибка извлечения видео или истечение времени запроса также приводят к сбою.
Авто по умолчанию false для подписей, предоставляемых загрузчиком. Установите true для автоматических подписей. API никогда не переключается на источники подписи.
API считывает существующие подписи YouTube; он не генерирует новые транскрипты. Реакция по умолчанию содержит нормализованные сегменты JSON; Accept может выбрать простой текст, а X-Respond-With: разметка выбирает Markdown. languageName может быть null; сохраняются сроки сегмента.
Несколько языков
Отправьте языковой массив для получения треков и ошибок на языке. Этот пример показывает, что английский язык доступен, а испанский недоступен.
{
"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"
}
]
}Все поля ответов
| Поле | Описание |
|---|---|
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[].codestring | language_unavailable, когда выбранный трек не существует; retrieval_failed, когда его нельзя загрузить или разобрать. |
results[0].errors[].messagestring | Описание языкового сбоя. |
Вышеприведенные поля описывают ответ JSON по умолчанию. JSON, простой текст и форматы Markdown.
Async возвращает одну квитанцию о приеме на работу; партия возвращает одну за одну работу Видео видео IDQ. Проверяйте статус каждой работы и извлекайте ее результаты, используя возвращенные ссылки.
Async и пакетный жизненный цикл
Подача возвращает квитанцию, а не результаты. Async создает одну работу; партия возвращает отдельную работу в queries[] на каждый принятый запрос. Отслеживайте и извлекайте каждую работу самостоятельно.
Представить data.flashdata.dev; читать статус работы и результаты api.flashdata.dev С тем же X-API-Key. Связанные базовые примеры API используют Python и cURL.
1. Сохранить работу IDs
Держите поля запросов этого источника при переходе на Async. Для Batch поместите каждый запрос в массив запросов объекта JSON. Сохраните все возвращенные работы ID.
2. Проверьте статус
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: Опрос с задержкой и уважениемRetry-Afterкогда присутствует.completed: Принесите результаты.failed: Проверитьjob.error.Читайте job.status, а не статус квитанции о представлении.
Проверить статус: Python и cURL
Статус работы API ссылка3. Получить результаты
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsПосле завершения аутентификации считывайте результат, а затем возьмите хранилище 302 URL без ключа API. Сохраните JSON в течение часов завершения 24.
Результаты поиска: Python и cURL · Форматы ответов
Результат скачивания ссылки API
Опросы и получение существующих результатов не потребляют кредиты запросов. Тайм-аут для голосования не отменяет работу: сохраняйте свой ID вместо того, чтобы подавать дубликат оплачиваемой работы. Коды ошибок и поведение retry.
Вебхуки завершения
Подписаться на запрос
Настройка callback_url на верхнем уровне асинхронного запроса, или Внутри каждого запроса в партии, снаружи params. Отдельного запроса на регистрацию webhook не требуется. Запросы Realtime не отправляют обратные вызовы.
Используйте общедоступный HTTPS URL на порту 443. FlashData POST - уведомление для каждой работы completed или failed; Событие содержит ссылки, а не сам результат.
Признать и проверить
Возвращение 2xx После того, как он принял это событие. Дублировать через delivery_id, Также посланный как X-Delivery-Id. Переадресации не выполняются.
Неудачные поставки с экспоненциальным обратным откатом, вплоть до 8 - полная версия и в большинстве 24 часов после завершения. Продолжайте опросы как запасной вариант.
Обратные звонки не подписаны. Подтвердить работу ID, исходный и терминальный статус через аутентифицированная конечная точка статуса перед обработкой уведомления. Поставка ID предназначена для дедупликации, а не для подтверждения подлинности.
Пример события web-cook и полей
{
"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"
}
]
}| Поле | Описание |
|---|---|
delivery_idstring | Стабильный идентификатор доставки. Дублировать уведомления с использованием этого значения; он также отправляется в заголовке X-Delivery-Id. |
idstring | Работать ID. |
sourcestring | Запрошенный источник данных. |
statusstring | завершены или не выполнены. |
linksarray | Статус и результат ссылки. Уведомления не включают контент результата или ключ API. |
links[].relstring | себя или результаты. |
links[].hrefstring | Абсолютный менеджмент API URL; аутентифицируйтесь с помощью ключа API. |
links[].methodstring | GET. |
Обработка файлов Bulk
Загрузите одно видео ID в строку и создайте задание Bulk с исходным кодом: youtube_captions. Общие опции применяются к каждому ID в файле.
Варианты источников: Язык, авто. Поместите их в опции при создании работы Bulk.
Восстановление завершенной коллекции в виде манифестных и сжатых с помощью gzip частей результата NDJSON. Источники данных также могут доставлять части результатов в ваше облачное хранилище, устанавливая options.result_storage при создании работы Bulk. Сохраняйте манифест и части внутри 24 Через несколько часов после всего Bulk Работа завершена.
Bulk Обработка API · Python и cURL · Запросы Batch JSON
Создайте рабочий процесс Bulk для этого источника · Пауза, возобновление и восстановление
Восстановление ошибок
Видео может иметь автоматические подписи, но не ручную дорожку или отсутствие запрашиваемого языка. Проверьте доступность подписи с помощью метаданных и выберите язык и происхождение перед новым представлением.
Проверьте доступные языки подписей с помощью Metadata. Новый запрос использует кредиты запросов; изменение трека не изменяет существующую работу.
Для аутентификации, баланса, сбоев формата запроса и ограничения скорости используйте общую ссылку на ошибку. Тайм-аут может все еще создать работу; проверьте существующую работу перед повторным использованием.
Ошибки и коды состояния · Когда повторно · Ограничения по ставкам
Пошаговое руководство: Заголовки с отметками времени
Цены
| Планы | Ставки использованияза 1 000 стандартных запросов | Подписки | Включенные кредиты за расчетный период |
|---|---|---|---|
| Оплата по использованию | 0,50 $ | Без ежемесячной платы | Пополняйте по мере необходимости |
| Micro | 0,40 $ | 49,00 $ / месяц | 1 000 кредиты ()50,00 $ из API использование, включая |
| Starter | 0,35 $ | 199,00 $ / месяц | 4 000 кредиты ()200,00 $ из API использование, включая |
| Pro | 0,30 $ | 499,00 $ / месяц | 10 000 кредиты ()500,00 $ из API использование, включая |
| Scale | 0,25 $ | 999,00 $ / месяц | 20 000 кредиты ()1 000,00 $ из API использование, включая |
| Business | 0,20 $ | 1 999,00 $ / месяц | 40 000 кредиты ()2 000,00 $ из API использование, включая |
Один тариф аккаунта. Общие кредиты для трёх продуктов. Использование, покрытое включёнными кредитами, повторно не оплачивается.
Текущие цены и лимиты плана