Jelajahi dokumentasi
Referensi API
YouTube Trainability API
Periksa YouTube metadata lisensi video untuk Creative Commons label dan mengambil hasilnya sebagai JSON.
Buat permintaan
ID sepanjang 11 karakter dari URL video, bukan URL lengkapnya.
https://data.flashdata.dev/v1/queries/realtimeParameter
Kirim source dan video_id di tingkat atas. Sumber ini tidak memiliki sumber - param spesifik. Bidang opsional dapat dihilangkan.
Isi permintaan
sourcestring / Wajib- Set ke youtube_trainability.
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}$ 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
Respons
Realtime kembali status: done. Baca keluaran sumber pada results[0].permitted; usage.credits Records the charge.
Hasil gema videoId dan laporan jenis, etag dan diperbolehkan. Pekerja memeriksa label lisensi video: ["all"] untuk label Creative Commons terdeteksi, jika tidak ["none"], termasuk metadata lisensi hilang.
Baca hasilnya
Simpan respon JSON sukses sebagai response.json. Simpan ini sebagai read-response.py dan jalankan python read-response.py. Ini hanya menggunakan Python perpustakaan standar dan tidak membuat permintaan baru.
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))Sumber ini tidak memiliki opsi spesifik sumber. Kirim video_id di tingkat atas; omit params.
Titik akhir ini tidak mengambil pengaturan pelatihan partai YouTube pencipta. Nilai tidak diizinkan memberikan hak pelatihan; bidang hanya ini lisensi-label cek keluaran.
Semua ruas respon
| Ruas | Deskripsi |
|---|---|
sourcestring | Sumber yang diminta API. |
statusstring | dilakukan ketika permintaan realtime sukses. |
created_atstring | Waktu pembuatan respon dalam format ISO 8601. |
usage.creditsnumber | Kredit dikenakan biaya untuk permintaan, berdasarkan rencana Anda. |
results[0].videoIdstring | Video yang diminta ID. |
results[0].kindstring | FlashData tipe hasil: youtube # videoTrainability. |
results[0].etagstring | Video ID bergema sebagai tag respon. |
results[0].permittedarray<string> | ["all"] ketika label Creative Commons terdeteksi; sebaliknya ["none"], termasuk ketika metadata lisensi hilang. Nilai-nilai ini tidak melaporkan YouTube pencipta pengaturan pelatihan pihak ketiga. |
Bidang di atas menggambarkan respon baku JSON. JSON, teks polos dan Markdown format.
Async mengembalikan satu pekerjaan penerimaan; batch kembali satu per video ID. Periksa setiap status pekerjaan dan ambil hasilnya menggunakan link yang dikembalikan.
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
Simpan ruas permintaan sumber ini ketika beralih ke Async. Untuk Batch, masukkan setiap permintaan ke dalam daftar array dari objek JSON. 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.
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. permintaan Realtime tidak mengirim callbacks.
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_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"
}
]
}| 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_trainability. Pilihan bersama berlaku untuk setiap ID dalam berkas.
Sumber ini tidak memiliki opsi sourcespecific; set source dan upload berkas ID.
Ambil koleksi lengkap sebagai bagian hasil manifest dan gzip- terkompresi NDJSON. Sumber data juga dapat memberikan bagian hasil ke penyimpanan awan Anda dengan mengatur options.result_storage ketika membuat pekerjaan Bulk. 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
Galat saat pemulihan
A ["none"] hasil adalah pemeriksaan lisensi selesai, bukan pekerjaan gagal. Ini bisa berarti label lisensi tidak ada. Video yang dihapus atau tidak dapat diakses dapat gagal selama ekstraksi.
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: Label lisensi interpret
Harga
| Rencana | Laju penggunaanper 1.000 permintaan standar | Berlangganan | Periode kredit yang disertakan setiap billing |
|---|---|---|---|
| Bayar sesuai penggunaan | US$0,50 | Tanpa biaya bulanan | Isi ulang sesuai kebutuhan |
| Micro | US$0,40 | US$49,00 / bulan | 1.000 kredit (US$50,00 dari penggunaan API) included ded |
| Starter | US$0,35 | US$199,00 / bulan | 4.000 kredit (US$200,00 dari penggunaan API) included ded |
| Pro | US$0,30 | US$499,00 / bulan | 10.000 kredit (US$500,00 dari penggunaan API) included ded |
| Scale | US$0,25 | US$999,00 / bulan | 20.000 kredit (US$1.000,00 dari penggunaan API) included ded |
| Business | US$0,20 | 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