Переглянути документацію
Довідник API
YouTube Download API
Завантажити YouTube відео або аудіо на хмарне сховище. Виберіть роздільну здатність, формат і тривалість кліпу, потім відстежуйте синхронну роботу через завершення.
API завантаження відео YouTube — приклади Python
Створити запит
11-character ID з відео URL, не повний URL.
Розширені можливості медіа
Вибір формата наділяє якість, частоту кадрів та аудіомовний вибір. Формат виведення та посилання на кліпи все ще застосовуються. Кінець кліпу повинен слідувати старту; або межа може бути в'язаний.
Місце зберігання
У ролях використовується дата завантаження UTC (YYYYYMMDDD).
Додайте свої облікові дані для зберігання на сервері перед запуском коду. Вони потребують дозволу на завантаження файлів.
Вимоги до вимог та умов зберіганняMarkdown діє до готових результатів. Одержувачі та статус роботи зберігають свої оригінальні поля.
https://data.flashdata.dev/v1/queriesПараметри
Відправити source і video_id на рівні вершини. Параметри джерела відносяться до params. Додаткові поля можуть бути використані.
Тіло запиту
sourcestring / Обов’язково- Набір до youtube_download.
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.download_typestring / Необов’язково- audio_video об'єднує відео і аудіо; відео вибирає відео тільки; аудіо вибирає аудіо тільки.1 до 11 ЗіркиВартість:
audio_video / video / audioЗа замовчуванням:"audio_video" params.video_qualitystring / Необов’язково- Вибір дозволу відео. Omit для аудіо-тільки завантаження.1 до 40 ЗіркиВартість:
best / worst / <=144 / ==144 / >=144 / <=360 / ==360 / >=360 / <=480 / ==480 / >=480 / <=720 / ==720 / >=720 / <=1080 / ==1080 / >=1080 / <=1440 / ==1440 / >=1440 / <=2160 / ==2160 / >=2160 / <=4320 / ==4320 / >=4320За замовчуванням:"<=720" params.fpsstring / Необов’язково- Рама-рейтинг: >=, <= або == з подальшим значенням від 1 до 240. Omit для аудіо-тільки завантаження.1 до 6 ЗіркиЗа замовчуванням:
Не встановитиПрийнятий формат
^(?:>=|<=|==)(?:[1-9]\d?|1\d\d|2[0-3]\d|240)$ params.audio_languagestring / Необов’язково- Вибір аудіо доріжки. Додатки до audio_video та аудіо.1 до 8 ЗіркиВартість:
default / originalЗа замовчуванням:"default" params.audio_qualitystring / Необов’язково- Audio-only бітрейт в kbps, або кращий. Чисельні вибірки повинні бути відправлені як рядки. Omit для завантаження відео.1 до 10 ЗіркиВартість:
best / 320 / 256 / 192 / 128За замовчуванням:"best" params.output_formatstring / Необов’язково- Відео: mp4, вебм або mkv. Аудіо: m4a, mp3 або opus.1 до 10 ЗіркиВартість:
mp4 / webm / mkv / m4a / mp3 / opusЗа замовчуванням:mp4 (video) / m4a (audio) params.yt_dlp_formatstring / Необов’язково- Розширений вибір формату, від 1 до 1,024 символів після підрізання білого простору. Символи керування відхиляються. На Overrides video_quality, fps і audio_language, значення яких потім ігноруються; формат виведення та затискання все ще застосовуються.1 до 1 024 ЗіркиЗа замовчуванням:
Не встановити params.upload_metadataboolean / Необов’язково- Завантажте файл метаданих JSON разом із файлами медіа у вашому пристрої.
trueабоfalseЗа замовчуванням:false
Кріплення
params.start_atstring / Необов’язково- Запуск кліпу в H:MM:SS або HH:MM:SS формат, від 00:00:00 до 12:00:00. За замовчуванням до 00:00:00 при наявності тільки end_at.1 до 8 ЗіркиЗа замовчуванням:
Не встановитиПрийнятий формат
^\d{1,2}:[0-5]\d:[0-5]\d$ params.end_atstring / Необов’язково- Кінець кліпу в H:MM:SS або HH:MM:SS формат, до 12:00:00. Повинен бути пізніше, ніж start_at.1 до 8 ЗіркиЗа замовчуванням:
Не встановитиПрийнятий формат
^\d{1,2}:[0-5]\d:[0-5]\d$
Місце зберігання
params.storageobject / Обов’язково- Призначення для заповнених медіа файлів. Приймаються тільки перераховані поля зберігання.
params.storage.storage_typestring / Обов’язково- s3, s3_compatible, oss, gcs, azure, cos, bos або tos.
params.storage.storage_urlstring / Обов’язково- Неопимний відро або контейнерне ім'я, до 1,024 символів. Зняттям білого простору знімається. Для s3 використовуйте дійсне ім'я відра AWS без URL або шлях до папки; папки, що належать до object_prefix.
params.storage.object_prefixstring / Необов’язково- Префікс об'єктів, 1 до 512 символів. Кожен сегмент суспензії приймає букви ASCII, цифри, точки, носики та гіфени; порожні сегменти, . та .. відхилені. Ні провідний slash. Виводиться перекриття білого простору і одного причепа вії. YYYYMMDD використовує дату завантаження UTC, включаючи archive/YYYYMMDD.За замовчуванням:
"YYYYMMDD" params.storage.access_keystring / Необов’язково- ключ доступу для S3, S3-сумісні, OSS, COS, BOS або TOS; паровані secret_key.
params.storage.secret_keystring / Необов’язково- Таємний ключ для S3, S3-сумісні, OSS, COS, BOS або TOS.
params.storage.endpoint_urlstring / Необов’язково- Public HTTPS кінцева точка для S3-сумісного зберігання або OSS. COS, BOS і TOS, що подають його з регіону.
params.storage.regionstring / Необов’язково- Для COS, BOS і TOS, також постачання для S3 і S3-сумісних завантажень. Відро назви COS включають APPID.
params.storage.service_accountobject / Необов’язково- GCS сервісний рахунок: project_id, client_email і PEM private_key.
params.storage.account_namestring / Необов’язково- Назва облікового запису Azure. Використовуйте назву контейнера в storage_url.
params.storage.sas_tokenstring / Необов’язково- Написання контейнера Azure SAS з витривалістю та підписом.
Відповідь
Завантажувач запиту подає завантаження з Async або Batch і вимагає params.storage. HTTP 200 з status: pending підтверджує прийняття, не доставка. Batch повертає одне робоче надходження на відео ID.
Подати заявку usage.credits ЦЕНА ЗА ЧАС 0. Завантаження вексельованих за допомогою доставленого медіа об'єму після успішної доставки; додаткові файли метаданих не додають для завантаження зарядів.
Поли job.status до completed, потім отримати результат JSON. Детальніше про медіа results[0], в тому числі завантажених об'єктів file_url, розмір файлу і контроль.
Читати результат
Після завершення роботи, збережіть JSON з посиланням на його результати як response.json. Збережіть це як 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 = {name: result.get(name) for name in (
"file_url", "file_size", "md5", "duration", "output_format"
)}
# Use your storage credentials to access the media at file_url.
print(json.dumps(output, ensure_ascii=False, indent=2))Статус може містити інформацію про медіа job.result. За замовчуванням JSON використовує їх при наявності і в іншому випадку слідувати за rel: results посилання; не припустимо в режимі онлайн-закінчення завжди присутній.
Усі поля реагування на подачу
| Поле | Опис |
|---|---|
idstring | Завантажити роботу ID. |
sourcestring | youtube_download. |
statusstring | прийняти роботу. |
created_atstring | Час створення роботи в форматі ISO 8601. |
usage.creditsnumber | 0 на подачі. Завантаження здійснюється за рахунок доставленого обсягу даних. |
linksarray | Дотримуйтесь свого посилання на статус роботи та посилання на результати для завершення виходу. |
links[].relstring | само або результати. |
links[].hrefstring | URL до запиту з тим же ключем API. |
links[].methodstring | GET. |
Обрані поля файлів медіафайлів
| Поле | Опис |
|---|---|
results[0].file_urlstring | Місцезнаходження медіафайлу у вашому зберіганні. |
results[0].file_sizeinteger | Розмір файлу медіа в байтах. |
results[0].downloaded_bytesinteger | Закуповані медіа-байти, що використовуються для вексельизації. |
results[0].md5string | MD5 checksum медіафайлу. |
results[0].resolutionstring · nullable | Відео дозвіл, або null для аудіо-нав'язливого виходу або недоступної висоти. |
results[0].durationnumber · nullable | Тривалість за секундами при наявності. |
results[0].output_formatstring | Формат вихідного файлу. |
results[0].fpsnumber · nullable | Швидкість рами при наявності. |
results[0].video_codecstring · nullable | Відеокодек при наявності. |
results[0].audio_codecstring · nullable | При наявності аудіокоду. |
results[0].dynamic_rangestring · nullable | Відеодинамічний діапазон при наявності. |
results[0].metadataobject · optional | Метадані file_url, file_size і md5 при upload_metadata є true. Виключені з зарядів завантаження метаданих. |
На полях описано типову відповідь JSON. Параметри форматів застосовуються до запису доставки, а не медіа-файлу. JSON, звичайний текст і Markdown формати.
Async & пакетний життєвий цикл
Подача повертається квитанції, не результати. Async створює одну роботу; пакет повертає окрему роботу в queries[] для кожного прийнятого запиту. Відстежуйте та отримайте кожну роботу самостійно.
Подати data.flashdata.dev; читати статус роботи та результати з api.flashdata.dev з тим же X-API-Key. Приклади базових прикладів API використовують Python і cURL.
1. Заощаджуйте роботу IDs
Запустіть одну завантаження з Async або встановіть кілька запитів для завантаження всередині Batch запитів масив. Кожен запис потребує params.storage. Заощаджуйте кожну подану роботу ID.
2. Статус на сервери
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: опитування з затримкою та повагоюRetry-Afterприсутні.completed: результати fetch.failed: оглядjob.error.Читать job.status, не статус отримання інформації.
Перевірити статус · Python і cURL
Статус на сервери API посилання3. Результати Фетт
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsПісля завершення перевірте результат читати, після чого викинути 302 пам'ять URL без ключа API. Заощаджуйте JSON в межах 24 годин завершення.
JSON описує медіа, що доставляються до вашого сховища. Доступ до медіафайлу.
Результати розрахунків · Python і cURL · Формати відповідей
Завантажити API
Половлення та вилучення існуючих результатів не споживають кредитні запити. Час вилучення не скасовує роботу: зберігайте ID замість подання дублікатів, які запроваджують роботу. Коди помилок та поведінка птиця.
Вебхуки завершення
Підписатися на запит
Комплекти callback_url на рівні асинхронного запиту, або всередині кожного запиту в партії, поза params. Не потрібно окремий запит на веб-візію.
Використовуйте публічний 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_download",
"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_download. Доступні параметри застосовуються до кожного ID в файлі.
Поставте необхідний пункт зберігання в options.storage та налаштування медіа в options. Один-job і Batch скачати замість params.storage.
Файли медіа доставляються до хмарного сховища. Завершено Bulk результат включає в себе проявляються і результати, що описують завантаження. Заощаджуйте прояву і частини в 24 години після завершення роботи Bulk.
Bulk обробка API · Python і cURL · Batch JSON запитів
Створіть робочий потік Bulk для цього джерела · Пауза, резюме і відновлення
Місце зберігання
Включити params.storage у кожному запиту завантаження. Комплекти storage_url до вашого відро або контейнерного імені і поставлення облікових записів з доступом для запису. Зберігати облікові дані на сервері.
{
"storage_type": "s3_compatible",
"storage_url": "your-media-bucket",
"object_prefix": "archive/YYYYMMDD",
"endpoint_url": "https://your-s3-endpoint.example.com",
"region": "your-provider-region",
"access_key": "<storage-access-key>",
"secret_key": "<storage-secret-key>"
}object_prefix За замовчуванням YYYYMMDD, заміщено датою завантаження UTC. Використовуйте фіксований каталог або шаблон, такі як archive/YYYYMMDD.
s3- Постачання access_key і secret_key з доступом до запису. Встановити область до області AWS відра.
s3 Приклади
{ "storage_type": "s3", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "us-east-1" } s3_compatible- Поставка access_key, secret_key і громадська HTTPS endpoint_url. Настроювання регіону, що вимагається вашим постачальником; Cloudflare R2 використовує авто.
s3_compatible Приклади
{ "storage_type": "s3_compatible", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "endpoint_url": "https://YOUR_ACCOUNT_ID.r2.cloudflarestorage.com", "region": "auto" } azure- Поставка account_name і sas_token, контейнер SAS з письмовим дозволом (сп включає в себе w), ресурсний sr=c, expiry se, версія sv і підпису sig. storage_url - назва контейнера. Не надсилайте endpoint_url, access_key або secret_key.
azure Приклади
{ "storage_type": "azure", "storage_url": "your-media-container", "account_name": "yourstorageaccount", "sas_token": "sv=2023-11-03&sr=c&sp=w&se=2099-01-01T00%3A00%3A00Z&sig=YOUR_SAS_SIGNATURE" } bos- Постачання access_key, secret_key та області: bj, su або hkg. Кінцева точка виводиться з регіону при в'язанні. Використовуйте назву відра без точок.
bos Приклади
{ "storage_type": "bos", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "bj" } cos- Постачання access_key, secret_key і ap-* область, такі як ap-hongkong. storage_url повинна включати в себе застосунок APPID. Не надсилайте endpoint_url; він виходить з регіону.
cos Приклади
{ "storage_type": "cos", "storage_url": "your-media-bucket-1234567890", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "ap-hongkong" } gcs- Поставка service_account з project_id, client_email (адреса .gserviceaccount.com), і PEM private_key з вашого облікового запису служби. Враховуйте доступ до відро. Не надсилайте access_key, secret_key, регіон або endpoint_url.
gcs Приклади
{ "storage_type": "gcs", "storage_url": "your-media-bucket", "service_account": { "project_id": "your-project-id", "client_email": "[email protected]", "private_key": "-----BEGIN PRIVATE KEY-----\nYOUR_PRIVATE_KEY\n-----END PRIVATE KEY-----\n" } } oss- Поставка access_key, secret_key та громадська HTTPS endpoint_url.
oss Приклади
{ "storage_type": "oss", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "endpoint_url": "https://oss-cn-hongkong.aliyuncs.com" } tos- Постачання access_key, secret_key та області з cn-, ap-, eu- або us- префіксом. Кінцева точка виводиться з регіону при в'язанні. Використовуйте назву відра без точок.
tos Приклади
{ "storage_type": "tos", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "cn-beijing" }
Результати file_url визначає об'єкт у вашому зберіганні. Приватні об'єкти вимагають авторизації вашого оператора або підписаного URL; ключ FlashData API не надає доступу до вашого відро.
Для повного подання, опитування та завантаження робочого процесу див. Завантажити YouTube аудіо до Amazon S3.
Доставка файлів
Робота rel: results кінцева точка за замовчуванням для перенаправлення результат JSON, не завантажити MP4. FlashData завантажує фактичні медіа на відро або контейнер, який ви поставляєте. Затримка ЗМІ: Політика відра; результат роботи JSON завершує 24 години після завершення роботи.
results[0].file_url визначає об'єкт, але не автоматично публічний або підписаний URL. Доступ до приватних медіа з вашим сховищем SDK або створення короткочасних підписаних URL на вашому сервері. Не надсилайте ключ FlashData API до вашого постачальника зберігання.
Увімкнути upload_metadata завантажити {video_id}_meta.json Супутник в одному префіксі. Місце розташування та контроль results[0].metadata.
Режим завантаження консолі окремий. Публічна завантаження API використовує власне сховище; не включають консоль browser_delivery налаштування.
Відновлення пароля
Для завантаження несправностей або зберігання 403, перевірити провайдера, відро, область, кінцева точка та дозвіл на об'єкт. Невідкладна або приватна file_url не по собі означає, що завантаження не вдалося: перевірити об'єкт через постачальника зберігання.
Видалено або не можна відновити відео за допомогою опитувань. Для форматів, які недоступні, інспекції Формати метаданих, розслабляйте якісні обмеження або видаліть передовий вибірник. Вимоги до аудіо-навігації m4a, mp3 або opus; відео-запити вимагають mp4, webm або mkv.
Якщо результат JSON розширився, спочатку перевірте свій відро для доставлених ЗМІ. Відшкодування створює нову завантаження і може призвести до іншого заряду; він не відновлює старий результат JSON.
Для автентифікації, балансу, запиту та обмеження, використовуйте посилання на спільну помилку. Термін подачі може бути ще створено роботу; перевірити існуючу роботу перед спрацьовуванням.
Покроковий посібник: Завантажити одне відео та перевірити доставку
Ціни
| Плани | Тарифи на користуванняна GB доставлено | Абоненти | Включені кредити за вексельний період |
|---|---|---|---|
| Оплата за використання | 0,10 USD | Без щомісячної плати | Поповнюйте за потреби |
| Micro | 0,08 USD | 49,00 USD / місяць | 1 000 кредити (50,00 USD використання API) включені |
| Starter | 0,07 USD | 199,00 USD / місяць | 4 000 кредити (200,00 USD використання API) включені |
| Pro | 0,06 USD | 499,00 USD / місяць | 10 000 кредити (500,00 USD використання API) включені |
| Scale | 0,05 USD | 999,00 USD / місяць | 20 000 кредити (1 000,00 USD використання API) включені |
| Business | 0,04 USD | 1 999,00 USD / місяць | 40 000 кредити (2 000,00 USD використання API) включені |
Один тариф облікового запису. Спільні кредити для трьох продуктів. Використання, покрите включеними кредитами, повторно не оплачується.
Поточні ціни та ліміти плану