Перейти к содержимому
RU
Ключ API
Обзор документации

Справочник API

YouTube Trainability API

Получите API-ключ

Проверьте метаданные лицензии видео YouTube для ярлыка Creative Commons и получите результат JSON.

Создать запрос

11-символ ID из видео URL, а не полный URL.

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_trainability",
    "video_id": "dQw4w9WgXcQ",
}

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 на высшем уровне. Этот источник не имеет парамов, специфичных для источника. Факультативные поля можно опустить.

Тело запроса

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

Ответ

Realtime возвращается status: done. Прочитайте исходный текст на results[0].permitted; usage.credits Записывает обвинение.

Результат перекликается с videoId и отчетами типа, этэга и разрешенного. Работник проверяет лицензионную этикетку видео: ["all"] на обнаруженную этикетку Creative Commons, в противном случае ["none"], включая отсутствующие метаданные лицензии.

Прочитайте результат

Сохраните успешный ответ 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 = {"videoId": result.get("videoId"), "permitted": result.get("permitted", [])}
# Keep the label values; this is not a training-rights authorization.
print(json.dumps(output, ensure_ascii=False, indent=2))

Этот источник не имеет специфических вариантов. Отправьте video_id на верхнем уровне; опустить парам.

Эта конечная точка не восстанавливает настройки обучения третьей стороны создателя YouTube. Ни одна из разрешенных стоимостей не предоставляет права на обучение; поле является только результатом проверки по лицензии.

Все поля ответов
ПолеОписание
sourcestringЗапрошенный источник API.
statusstringДелается, когда запрос в режиме реального времени успешен.
created_atstringВремя создания ответов в формате ISO 8601.
usage.creditsnumberКредиты, взимаемые за запрос, исходя из вашего плана.
results[0].videoIdstringЗапрошенное видео ID.
results[0].kindstringТип результата FlashData: youtube#videoTrainability.
results[0].etagstringВидео ID перекликается с тегом ответа.
results[0].permittedarray<string>["all"] при обнаружении ярлыка Creative Commons; в противном случае ["none"], в том числе при отсутствии метаданных лицензии. Эти значения не сообщают о настройках обучения третьей стороны создателя YouTube.

Вышеприведенные поля описывают ответ JSON по умолчанию. JSON, простой текст и форматы Markdown.

Async возвращает одну квитанцию о приеме на работу; партия возвращает одну за одну работу Видео видео IDQ. Проверяйте статус каждой работы и извлекайте ее результаты, используя возвращенные ссылки.

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: Принесите результаты. 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 вместо того, чтобы подавать дубликат оплачиваемой работы. Коды ошибок и поведение 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_trainability",
  "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_trainability. Общие опции применяются к каждому ID в файле.

Этот источник не имеет опций для конкретного источника; установите источник и загрузите файл ID.

Восстановление завершенной коллекции в виде манифестных и сжатых с помощью gzip частей результата NDJSON. Источники данных также могут доставлять части результатов в ваше облачное хранилище, устанавливая options.result_storage при создании работы Bulk. Сохраняйте манифест и части внутри 24 Через несколько часов после всего Bulk Работа завершена.

Bulk Обработка API · Python и cURL · Запросы Batch JSON

Создайте рабочий процесс Bulk для этого источника · Пауза, возобновление и восстановление

Восстановление ошибок

Результатом ["none"] является завершенная проверка лицензии, а не неудачная работа. Это может означать, что ярлык лицензии отсутствовал. Снятые или недоступные видео могут выйти из строя во время извлечения.

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

Ошибки и коды состояния · Когда повторно · Ограничения по ставкам

Пошаговое руководство: Интерпретировать этикетки лицензий

Цены

ПланыСтавки использованияза 1 000 стандартных запросовПодпискиВключенные кредиты за расчетный период
Оплата по использованию0,50 $Без ежемесячной платыПополняйте по мере необходимости
Micro0,40 $49,00 $ / месяц1 000 кредиты ()50,00 $ из API использование, включая
Starter0,35 $199,00 $ / месяц4 000 кредиты ()200,00 $ из API использование, включая
Pro0,30 $499,00 $ / месяц10 000 кредиты ()500,00 $ из API использование, включая
Scale0,25 $999,00 $ / месяц20 000 кредиты ()1 000,00 $ из API использование, включая
Business0,20 $1 999,00 $ / месяц40 000 кредиты ()2 000,00 $ из API использование, включая

Один тариф аккаунта. Общие кредиты для трёх продуктов. Использование, покрытое включёнными кредитами, повторно не оплачивается.

Текущие цены и лимиты плана