Jelajahi dokumentasi
Referensi API
YouTube Download API
Unduh YouTube video atau audio ke penyimpanan awan Anda. Pilih resolusi, format, dan durasi klip, kemudian lacak tugas asinkron melalui pelengkapan.
API unduhan video YouTube — contoh Python
Buat permintaan
ID sepanjang 11 karakter dari URL video, bukan URL lengkapnya.
Opsi media tingkat lanjut
Pemilihan format menimpa kualitas, laju bingkai, dan pilihan bahasa audio. Format keluaran dan batas klip masih berlaku. Clip end harus mengikuti awal; baik terikat dapat dihilangkan.
Tujuan penyimpanan
Kosong memakai tanggal upload UTC (YYYYMMDD).
Tambahkan kredensial penyimpanan Anda pada server Anda sebelum menjalankan kode. Mereka perlu izin untuk meng-upload file.
Penyedia kredensial dan kebutuhan penyimpananPengait web penyelesaian
Muatan Webhook, verifikasi, dan coba lagiMarkdown berlaku untuk hasil selesai. Tanda terima dan status pekerjaan menjaga bidang asli mereka.
https://data.flashdata.dev/v1/queriesParameter
Kirim source dan video_id di tingkat atas. Pilihan sumber termasuk dalam params. Bidang opsional dapat dihilangkan.
Isi permintaan
sourcestring / Wajib- Set ke youtube_download.
video_idstring / Wajib- Karakter 11-YouTube video ID, seperti FUFFGCZ092b0. Menerima surat, nomor, garis bawah dan tanda hubung.Tepat 11 karakterBaku:
Tak ditataFormat yang diterima
^[A-Za-z0-9_-]{11}$ paramsobject / Wajib- Settings untuk permintaan ini.
callback_urlstring · nullable / Opsional- Async dan batch saja. Publik HTTPS pelengkapan URL di port 443, sampai 2,048 karakter. Tak ada kredensial pengguna atau fragmen URL. Omit, gunakan null atau string kosong untuk tanpa pemberitahuan. Dalam batch, set ini pada setiap query, di luar param.Baku:
Tak ditata
Video & audio
params.download_typestring / Opsional- audio_video menggabungkan video dan audio; hanya memilih video; pemilih audio saja.1 ke 11 karakterNilai:
audio_video / video / audioBaku:"audio_video" params.video_qualitystring / Opsional- Seleksi resolusi video. Keluarkan untuk audio- hanya unduhan.1 ke 40 karakterNilai:
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 / >=4320Baku:"<=720" params.fpsstring / Opsional- Batas rate Frame-: > =, < = atau = = diikuti dengan nilai dari 1 ke 240. Keluarkan untuk audio- hanya unduhan.1 ke 6 karakterBaku:
Tak ditataFormat yang diterima
^(?:>=|<=|==)(?:[1-9]\d?|1\d\d|2[0-3]\d|240)$ params.audio_languagestring / Opsional- Pilihan trek audio. Aplikasi ke audio_video dan audio.1 ke 8 karakterNilai:
default / originalBaku:"default" params.audio_qualitystring / Opsional- Audio- hanya bitrate dalam kbps, atau yang terbaik. Pilihan numerik harus dikirim sebagai string. Keluarkan untuk mengunduh video.1 ke 10 karakterNilai:
best / 320 / 256 / 192 / 128Baku:"best" params.output_formatstring / Opsional- Video: mp4, webm atau mkv. Audio: m4a, mp3 atau opus.1 ke 10 karakterNilai:
mp4 / webm / mkv / m4a / mp3 / opusBaku:mp4 (video) / m4a (audio) params.yt_dlp_formatstring / Opsional- Penunjuk format lanjutan, dari 1 ke 1,024 karakter setelah pemecahan whitespace. Karakter kontrol ditolak. Timpa video_quality, fps dan audio_language, nilai-nilainya kemudian diabaikan; format keluaran dan kliping masih berlaku.1 ke 1.024 karakterBaku:
Tak ditata params.upload_metadataboolean / Opsional- Unggah berkas metadata JSON bersama berkas media di penyimpanan Anda.
trueataufalseBaku:false
Mengklik
params.start_atstring / Opsional- Awal klik dalam H: MM: SS atau HH: MM: Format SS, dari 00:00:00 ke 12:00:00. Baku untuk 00:00:00 ketika hanya end_at yang disediakan.1 ke 8 karakterBaku:
Tak ditataFormat yang diterima
^\d{1,2}:[0-5]\d:[0-5]\d$ params.end_atstring / Opsional- Format klip di H: MM: SS atau HH: MM: SS, hingga 12:00:00. Pasti lebih lambat dari start_at.1 ke 8 karakterBaku:
Tak ditataFormat yang diterima
^\d{1,2}:[0-5]\d:[0-5]\d$
Tujuan penyimpanan
params.storageobject / Wajib- Tujuan untuk berkas media yang selesai. Hanya area penyimpanan yang terdaftar yang diterima.
params.storage.storage_typestring / Wajib- Penyedia penyimpanan: s3, s3_compatible, oss, gcs, azure, cos, bos atau tos.
params.storage.storage_urlstring / Wajib- Ember kosong atau nama kontainer, hingga karakter 1,024. Sekitar whitespace dihapus. Untuk s3, gunakan nama bucket AWS yang valid tanpa URL atau path folder; folder milik dalam object_prefix.
params.storage.object_prefixstring / Opsional- Object- prefiks kunci, 1 untuk karakter 512. Setiap segmen terpisah-slash menerima huruf ASCII, digit, titik, garis bawah dan hyphens; segmen kosong,. dan.. ditolak. Tidak ada garis miring. Mengelilingi ruang putih dan satu garis miring yang tertinggal dihapus. YYYYMMDD menggunakan tanggal upload UTC, termasuk dalam archive/YYYYMMDD.Baku:
"YYYYMMDD" params.storage.access_keystring / Opsional- Kunci akses untuk S3, kompatibel S3Q-, OSS, COS, BOS atau TOS; dipasangkan dengan secret_key.
params.storage.secret_keystring / Opsional- Kunci rahasia untuk S3, S3Q- kompatibel, OSS, COS, BOS atau TOS.
params.storage.endpoint_urlstring / Opsional- Publik HTTPS titik akhir untuk S3- yang kompatibel dengan penyimpanan atau OSS. COS, BOS dan TOS mendapatkannya dari wilayah.
params.storage.regionstring / Opsional- Diperlukan untuk COS, BOS dan TOS; juga persediaan untuk unduhan S3 dan S3Q- yang kompatibel. COS nama ember termasuk APPID.
params.storage.service_accountobject / Opsional- GCS akun layanan: project_id, client_email dan PEM private_key.
params.storage.account_namestring / Opsional- Azure nama rekening penyimpanan. Gunakan nama kontainer dalam storage_url.
params.storage.sas_tokenstring / Opsional- Write- diaktifkan Azure kontainer SAS dengan kadaluwarsa dan tanda tangan.
Respons
Pembangun permintaan menyerahkan pengunduhan dengan Async atau Batch dan memerlukan params.storage. HTTP 200 dengan status: pending Mengkonfirmasi penerimaan, bukan pengiriman. Batch mengembalikan satu pekerjaan penerimaan per video ID.
Submission usage.credits adalah 0. Unduhan ditagih oleh volume media yang disampaikan setelah pengiriman sukses; berkas metadata opsional tidak menambah biaya unduhan.
Poll job.status sampai completed, kemudian mengambil hasil JSON. Baca rincian media di results[0], termasuk objek yang diunggah file_url, ukuran berkas dan checksum.
Baca hasilnya
Setelah pekerjaan selesai, simpan JSON dari hasil link sebagai response.json. Simpan ini sebagai read-response.py dan jalankan python read-response.py. Ini membaca rincian berkas tanpa mengunduh media atau membuat permintaan lain.
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))Status dapat memasukkan rincian media job.result. JSON baku mengalir menggunakan mereka ketika tersedia dan jika tidak mengikuti rel: results link; jangan asumsikan hasil inline selalu ada.
Semua ruas respon pengiriman
| Ruas | Deskripsi |
|---|---|
idstring | Download job ID. |
sourcestring | youtube_download. |
statusstring | menunggu ketika pekerjaan diterima. |
created_atstring | Waktu pembuatan Job dalam format ISO 8601. |
usage.creditsnumber | 0 di pengiriman. Unduhan diisi oleh volume data yang dikirim setelah pelengkapan. |
linksarray | Ikuti link mandiri untuk status kerja dan taut hasil untuk keluaran yang selesai. |
links[].relstring | diri atau hasil. |
links[].hrefstring | URL untuk query dengan sama API kunci. |
links[].methodstring | GET. |
Ruas berkas media yang komplit
| Ruas | Deskripsi |
|---|---|
results[0].file_urlstring | Lokasi berkas media di penyimpanan Anda. |
results[0].file_sizeinteger | Ukuran berkas media dalam bita. |
results[0].downloaded_bytesinteger | Dikirim byte media yang digunakan untuk penagihan. |
results[0].md5string | MD5 checksum dari berkas media. |
results[0].resolutionstring · nullable | Resolusi video, atau null untuk audio- hanya keluaran atau tinggi tidak tersedia. |
results[0].durationnumber · nullable | Durasi dalam detik ketika tersedia. |
results[0].output_formatstring | Format berkas keluaran. |
results[0].fpsnumber · nullable | Tingkat bingkai ketika tersedia. |
results[0].video_codecstring · nullable | Codec video ketika tersedia. |
results[0].audio_codecstring · nullable | Kodec audio saat tersedia. |
results[0].dynamic_rangestring · nullable | Jangkauan dinamis video ketika tersedia. |
results[0].metadataobject · optional | Metadata file_url, file_size dan md5 ketika upload_metadata adalah true. bytes metadata tidak termasuk dari biaya pengunduhan. |
Bidang di atas menggambarkan respon baku JSON. Opsi format diterapkan ke catatan pengiriman, bukan berkas media. JSON, teks polos dan Markdown format.
Async & batch lifecycle
Submission mengembalikan tanda terima, bukan hasil. Async menciptakan satu pekerjaan; batch mengembalikan pekerjaan terpisah di queries[] untuk setiap permintaan diterima. Lacak dan ambil setiap pekerjaan secara independen.
Kirim ke data.flashdata.dev; membaca status pekerjaan dan hasil dari api.flashdata.dev dengan X-API-Key yang sama. Contoh dasar API terkait menggunakan Python dan cURL.
1. Simpan pekerjaan IDs
Kirim satu unduh dengan Async, atau masukkan permintaan pengunduhan ganda di dalam kueri Batch. Setiap entri membutuhkan params.storage. Simpan setiap pekerjaan yang kembali ID.
2. Periksa status
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: polling dengan penundaan dan rasa hormatRetry-Afterketika hadir.completed: Mengambil hasil.failed: memeriksajob.error.Baca job.status, bukan pengajuan status penerimaan.
Periksa status Python dan cURL
Status tugas API referensi3. Ambil hasil
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsSetelah selesai, otentikasi hasil dibaca, kemudian ambil penyimpanan 302 URL tanpa kunci API Anda. Simpan JSON dalam waktu penyelesaian 24.
The JSON menggambarkan media dikirim ke penyimpanan Anda. Mengakses berkas media.
Ambil hasil Python dan cURL · Format respons
Hasil download referensi API
Polling dan mengambil hasil yang sudah ada jangan mengkonsumsi kredit query. Pengungutan waktu pemungutan suara tidak membatalkan pekerjaan: menyimpan ID nya sebagai ganti mengirimkan duplikat pekerjaan yang dapat ditagih. Galat kode dan coba lagi perilaku.
Webhook penyelesaian
Berlangganan setiap kueri
Set callback_url pada tingkat atas permintaan async, atau didalam setiap query dalam batch, di luar params. Tak ada permintaan pendaftaran web-hook- terpisah yang diperlukan.
Gunakan publik HTTPS URL di port 443. FlashData POSTs pemberitahuan untuk setiap pekerjaan mencapai completed atau failed; peristiwa ini berisi taut, bukan hasil itu sendiri.
Mengakui dan memverifikasi
Kembali 2xx Setelah lama menerima acara itu. Deduplikasi oleh delivery_id, juga dikirim sebagai X-Delivery-Id. Redireksi tidak diikuti.
Gagal pengiriman coba ulang dengan backoff eksponensial, sampai 8 mencoba total dan paling banyak 24 jam setelah selesai. Tetap polling sebagai mundur.
Callbacks tidak ditandatangani. Konfirmasi tugas ID, status sumber dan terminal melalui titik akhir status yang terotentikasi sebelum memproses pemberitahuan. Pengiriman ID adalah untuk deduplikasi, bukan bukti keaslian.
Contoh acara webhook dan ruas
{
"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"
}
]
}| Ruas | Deskripsi |
|---|---|
delivery_idstring | Identifikasi pengiriman stabil. Pemberitahuan duplikat memakai nilai ini; ini juga dikirim dalam header X-Delivery-Id. |
idstring | Job ID. |
sourcestring | Sumber data yang diminta. |
statusstring | selesai atau gagal. |
linksarray | Status dan hasil link. Pemberitahuan tidak termasuk isi hasil atau kunci API. |
links[].relstring | diri atau hasil. |
links[].hrefstring | Manajemen Absolute API URL; otentikasi dengan kunci API Anda. |
links[].methodstring | GET. |
Bulk pemrosesan berkas
Upload satu video ID per baris dan membuat pekerjaan Bulk dengan sumber: youtube_download. Pilihan bersama berlaku untuk setiap ID dalam berkas.
Masukkan tujuan penyimpanan yang diperlukan options.storage dan pengaturan media dalam options. Single- pekerjaan dan Batch unduhan menggunakan params.storage sebagai gantinya.
Berkas media dikirim ke penyimpanan awan Anda. Hasil Bulk yang lengkap termasuk bagian manifest dan hasil yang menjelaskan pengunduhan. Simpan manifes dan bagian dalam 24 jam setelah seluruh Bulk pekerjaan selesai.
Bulk memproses API · Python dan cURL · permintaan Batch JSON
Bangun Bulk alur kerja bagi sumber ini · Jeda, lanjutkan dan pulihkan
Tujuan penyimpanan
Sertakan params.storage dalam setiap permintaan download. Set storage_url ke ember Anda atau nama kontainer dan kredensial pasokan dengan akses tulis. Simpan mandat penyimpanan di server Anda.
{
"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 default ke YYYYMMDD, diganti dengan tanggal upload UTC. Gunakan direktori tetap atau template seperti archive/YYYYMMDD.
s3- Supply access_key dan secret_key dengan menulis akses. Atur wilayah ke wilayah AWS ember Anda.
s3 contoh
{ "storage_type": "s3", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "us-east-1" } s3_compatible- Suplai access_key, secret_key dan publik HTTPS endpoint_url. Atur wilayah seperti yang diperlukan oleh penyedia Anda; Cloudflare R2 menggunakan auto.
s3_compatible contoh
{ "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- Persediaan account_name dan sas_token, sebuah SAS kontainer dengan izin menulis (sp termasuk w), sumber daya sr = c, expiry se, version sv dan signature sig. storage_url adalah nama kontainer. Jangan kirim endpoint_url, access_key atau secret_key.
azure contoh
{ "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- Persediaan access_key, secret_key dan daerah: bj, su atau hkg. Titik akhir berasal dari daerah ketika diabaikan. Gunakan nama ember tanpa titik.
bos contoh
{ "storage_type": "bos", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "bj" } cos- Persediaan access_key, secret_key dan daerah ap- *, seperti ap- hongkong. storage_url harus menyertakan akhiran APPID. Jangan kirim endpoint_url; ini diturunkan dari daerah.
cos contoh
{ "storage_type": "cos", "storage_url": "your-media-bucket-1234567890", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "ap-hongkong" } gcs- Suplai service_account dengan project_id, client_email (alamat layanan Anda. gserviceaccount.com), dan PEM private_key dari akun layanan Anda. Rekening harus memiliki akses menulis ke ember. Jangan kirim access_key, secret_key, wilayah atau endpoint_url.
gcs contoh
{ "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- Suplai access_key, secret_key dan area ember publik HTTPS endpoint_url.
oss contoh
{ "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- Persediaan access_key, secret_key dan wilayah dengan cn-, ap-, ea- atau kita- prefix. Titik akhir berasal dari daerah ketika diabaikan. Gunakan nama ember tanpa titik.
tos contoh
{ "storage_type": "tos", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "cn-beijing" }
Hasilnya file_url Mengidentifikasi objek dalam penyimpanan Anda. Objek pribadi membutuhkan penyedia penyimpanan Anda atau URL yang ditandatangani; kunci FlashData API tidak memberikan akses ke ember Anda.
Untuk penyerahan lengkap, polling dan download alur kerja, lihat Unduh YouTube audio ke Amazon S3.
Pengiriman berkas
Pekerjaan itu rel: results titik akhir baku ke sebuah redirect ke hasil JSON, bukan download MP4. FlashData mengunggah media yang sebenarnya ke ember atau kontainer yang kau sediakan. Retensi media mengikuti kebijakan ember Anda; hasil kerja JSON berakhir 24 jam setelah selesai.
results[0].file_url Mengidentifikasi objek tetapi tidak secara otomatis publik atau ditandatangani URL. Akses media swasta dengan penyimpanan SDK, atau hasilkan kekurangan hidup URL pada server Anda sendiri. Jangan kirim FlashData API kunci ke penyedia penyimpanan Anda.
Aktifkan upload_metadata untuk mengunggah {video_id}_meta.json pendamping di awalan yang sama. Lokasinya dan checksum muncul di bawah results[0].metadata.
Mode unduh console 's Browser terpisah. Publik API unduhan menggunakan penyimpanan anda sendiri; jangan termasuk konsole-saja browser_delivery pengaturan.
Galat saat pemulihan
Untuk mengunggah kegagalan atau penyimpanan 403, periksa penyedia, ember, wilayah, titik akhir dan tujuan-tulis izin. Sebuah dapat dicapai atau private file_url tidak dengan sendirinya berarti upload gagal: periksa objek melalui penyedia penyimpanan Anda.
Sebuah video yang dihapus atau tidak tersedia tidak dapat dipulihkan dengan polling. Untuk format yang tidak tersedia, pemeriksaan Format metadata, limit kualitas santai atau hapus pemilih canggih. Permintaan audio- hanya dibutuhkan m4a, mp3 atau opus; permintaan; video membutuhkan mp4, webm atau mkv.
Jika hasil JSON telah berakhir, pertama periksa ember Anda untuk media yang disampaikan. Mengakui membuat download baru dan mungkin menimbulkan muatan lain; itu tidak memulihkan hasil lama JSON.
Untuk otentikasi, keseimbangan, format persyaratan, dan rate-batasi kegagalan, gunakan referensi galat bersama. Tenggat pengiriman mungkin masih menciptakan suatu pekerjaan; periksa pekerjaan yang telah ada sebelum mencoba kembali.
Kesalahan dan kode status · Kapan untuk mencoba lagi · Batas rate
Panduan langkah-demi-langkah: Unduh satu video dan verifikasi pengiriman
Harga
| Rencana | Laju penggunaanper GB dikirimkan | Berlangganan | Periode kredit yang disertakan setiap billing |
|---|---|---|---|
| Bayar sesuai penggunaan | US$0,10 | Tanpa biaya bulanan | Isi ulang sesuai kebutuhan |
| Micro | US$0,08 | US$49,00 / bulan | 1.000 kredit (US$50,00 dari penggunaan API) included ded |
| Starter | US$0,07 | US$199,00 / bulan | 4.000 kredit (US$200,00 dari penggunaan API) included ded |
| Pro | US$0,06 | US$499,00 / bulan | 10.000 kredit (US$500,00 dari penggunaan API) included ded |
| Scale | US$0,05 | US$999,00 / bulan | 20.000 kredit (US$1.000,00 dari penggunaan API) included ded |
| Business | US$0,04 | US$1.999,00 / bulan | 40.000 kredit (US$2.000,00 dari penggunaan API) included ded |
Satu paket akun. Kredit bersama untuk ketiga produk. Penggunaan yang tercakup dalam kredit paket tidak ditagih lagi.
Harga saat ini dan batas rencana