Semak dokumentasi
Rujukan API
Cipta dan kendali berbasis berkas YouTube Pekerjaan mereka, kemudian mengambil kembali manifes dan bagian hasilnya.
Pada halaman ini
Playground API
Pilih sumber dan salin lengkap Python atau Bash workflow, satu permintaan, atau respon sampel. Kode taman bermain; tidak memberikan pekerjaan. Aliran kerja yang lengkap menangani unggahan, pemeriksaan status dan pengambilan kembali setiap bagian hasil.
Bina aliran kerja Bulk
Berkas UTF-8 lokal, satu YouTube ID per baris, hingga 2 GiB. Persyaratan masuk ke dalam.
Hasil pengiriman
Biarkan ini pergi untuk mendapatkan hasil melalui FlashData API.
Bulk pelengkapan pelengkapan webhook
Pemakluman dan verifikasi Manifest-penyelesaianhttps://api.flashdata.dev/v2/bulk-jobsTitik akhir Ukiran
Semua titik akhir digunakan https://api.flashdata.dev/v2. → Buat sebuah pekerjaan → upload berkas video-ID → mulai → monitor → ambil manifes dan setiap bagian hasil.
| Metode Infak | Path | Aksi |
|---|---|---|
| POST | /v2/bulk-jobs | Buat pekerjaan Bulk |
| POST | /v2/bulk-jobs/{bulkId}/start | Muatnaik dan mulai |
| GET | /v2/bulk-jobs/{bulkId} | AKAN mendapat status pekerjaan |
| GET | /v2/bulk-jobs | Daftar pekerjaan |
| POST | /v2/bulk-jobs/{bulkId}/pause | Jeda kerja |
| PATCH | /v2/bulk-jobs/{bulkId} | Pilihan kerja update |
| POST | /v2/bulk-jobs/{bulkId}/resume | Kembali bekerja |
| DELETE | /v2/bulk-jobs/{bulkId} | ¡Chardin a job |
| GET | /v2/bulk-jobs/{bulkId}/results | Woindon mendapatkan hasil manifest |
| GET | /v2/bulk-jobs/{bulkId}/results/{partNumber} | Bagian hasil unduhan gandeng |
Autentikasi dan input
Diataskan FLASHDATA_API_KEY ke kunci dengan akses ke sumber yang dipilih. Anda menggunakan kembali kunci dan akun yang sama untuk penciptaan, kontrol dan hasil. Pemrosesan menggunakan saldo rekening dan harga per-sumber normal. YouTube Download membutuhkan akses pemilik dan options.storage.
Cipta folder kerja bernama bulk-api/ dan jalankan contoh ini dari folder tersebut. Aliran kerja Python lengkap dalam ruang uji menggunakan pustaka standard Python 3.10+; contoh titik akhir Python berasingan di bawah memerlukan Requests; contoh cURL menggunakan Bash, cURL 7.76+, jq dan gzip. Pilih satu bahasa untuk setiap tindakan supaya anda tidak mencipta atau memulakan kerja pendua.
Input žak adalah berkas UTF-8 dengan satu 11-karakter YouTube ID per baris, hingga 2 GiB. Guna IDs, bukan URLs. Buang pendua pendua IDs sebelum upload; berulang IDs diproses secara terpisah.
| Sumber | Pilihan Kongsi |
|---|---|
| youtube_metadata | include_formats, include_chapters |
| youtube_transcript | Bahasa, auto |
| youtube_captions | Bahasa, auto |
| youtube_trainability | Tak ada pilihan |
| youtube_download | Pilihan media dan destinasi penyimpanan |
python -m pip install requestsBuat bidang permintaan
| Ukrainian | Jenis | Penggunaan Teropong |
|---|---|---|
| source | string | Diperlukan. Salah satu sumber yang didukung untuk setiap input ID. |
| options | object | Pilihan sumber yang terkongsi. Sumber data mungkin menetapkan result_storage; YouTube Download membutuhkan penyimpanan. |
| callback_url | string | Panggilan balik penyelesaian HTTPS untuk umum opsional. (Inggris) Where Sent after manifes publikasi. |
Buat pekerjaan Bulk
Buat pekerjaan, muat naik UTF-8 Berkas teks jarfine dengan satu 11-character YouTube video ID darx <b> upload.hrefKalau begitu, telepon dulu. Menciptakan pekerjaan saja tidak mulai diproses.
Contoh ini menulis video-ids.txt dan menyimpan penerimaan 201 ke bulk-created.json. Memastikan penerimaan itu secara pribadi dan menggunakan kembali job.idQ untuk setiap permintaan selanjutnya. Menciptakan sebuah pekerjaan meninggalkannya dalam awaiting_upload; upload URL berakhir setelah 15 menit.
POST https://api.flashdata.dev/v2/bulk-jobs
X-API-Key: YOUR_API_KEYSimpan bulk_create.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
os.umask(0o077)
Path("video-ids.txt").write_bytes(b"jNQXAC9IVRw\ndQw4w9WgXcQ\n")
response = requests.post(
"https://api.flashdata.dev/v2/bulk-jobs",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
json={"source": "youtube_metadata", "options": {"include_formats": False}},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
receipt = response.json()
Path("bulk-created.json").write_text(json.dumps(receipt, indent=2), encoding="utf-8")
print(json.dumps(receipt["job"], indent=2))python bulk_create.pyumask 077
printf '%s\n' 'jNQXAC9IVRw' 'dQw4w9WgXcQ' > video-ids.txt
curl --fail-with-body --silent --show-error \
'https://api.flashdata.dev/v2/bulk-jobs' \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{"source":"youtube_metadata","options":{"include_formats":false}}' \
--output bulk-created.json &&
jq '.job | {id, source, status}' bulk-created.jsonSambutan dan permintaan skema
| Status HTTP | Arti |
|---|---|
| 201 | Kerja Bulk dibuat dengan 15-minute direct upload URL |
| 401 | Pengesahan diperlukan atau tidak sah |
| 422 | Permintaan validasi quest gagal |
| 503 | TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara |
{
"$ref": "#/components/schemas/CreateBulkJobRequest"
}{
"$ref": "#/components/schemas/BulkJobCreated"
}Muatnaik dan mulai
Mulai memproses berkas UTF-8 video ID yang diunggah, hingga 2 GiB (2147483648 bytes). Jaga berkasnya tidak berubah setelah dimulai.
Mula-mula hantar video-ids.txt dengan PUT ke upload.href dalam resit, menggunakan upload.contentType tanpa X-API-Key. Contoh memanggil start hanya selepas muat naik berjaya. Jangan ubah fail yang telah dimuat naik selepas itu.
| Parameter | Lokasi | Keperluan Keperluan Kemurtadan |
|---|---|---|
| bulkId | path | Wajib · {"type":"string","pattern":"^bulk_[A-Za-z0-9_-]{8,}$"} |
POST https://api.flashdata.dev/v2/bulk-jobs/{bulkId}/start
X-API-Key: YOUR_API_KEYSimpan bulk_start.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
receipt = json.loads(Path("bulk-created.json").read_text(encoding="utf-8"))
upload = receipt["upload"]
if upload["method"] != "PUT" or not upload["href"].startswith("https://"):
raise ValueError("Expected an HTTPS PUT upload URL")
# Stream the file to storage without the FlashData key.
with open("video-ids.txt", "rb") as file:
response = requests.put(
upload["href"], data=file,
headers={"Content-Type": upload["contentType"]},
timeout=300, allow_redirects=False,
)
response.raise_for_status()
if not 200 <= response.status_code < 300:
raise RuntimeError("Upload did not complete; do not start the job yet")
bulk_id = receipt["job"]["id"]
response = requests.post(
f"https://api.flashdata.dev/v2/bulk-jobs/{bulk_id}/start",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(json.dumps(response.json()["job"], indent=2))python bulk_start.pyBULK_ID=$(jq -er '.job.id' bulk-created.json)
UPLOAD_URL=$(jq -er '.upload.href' bulk-created.json)
CONTENT_TYPE=$(jq -er '.upload.contentType' bulk-created.json)
curl --fail-with-body --silent --show-error --proto '=https' \
--header "Content-Type: $CONTENT_TYPE" \
--upload-file video-ids.txt "$UPLOAD_URL" &&
curl --fail-with-body --silent --show-error --request POST \
"https://api.flashdata.dev/v2/bulk-jobs/$BULK_ID/start" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}"Balasan
| Status HTTP | Arti |
|---|---|
| 200 | Pekerjaan Bulk dimulai atau keadaan idempoten saat ini |
| 401 | Pengesahan diperlukan atau tidak sah |
| 404 | Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon |
| 409 | Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan |
| 422 | Permintaan validasi quest gagal |
| 503 | TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara |
{
"$ref": "#/components/schemas/BulkJobResponse"
}AKAN mendapat status pekerjaan
¡job.status, input, jumlah, pauseReason dan kesalahan. Recheck ID yang sama dengan penundaan; selesai berarti manifes diterbitkan, bukan bahwa setiap video berhasil.
| Parameter | Lokasi | Keperluan Keperluan Kemurtadan |
|---|---|---|
| bulkId | path | Wajib · {"type":"string","pattern":"^bulk_[A-Za-z0-9_-]{8,}$"} |
GET https://api.flashdata.dev/v2/bulk-jobs/{bulkId}
X-API-Key: YOUR_API_KEYSimpan bulk_status.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
bulk_id = json.loads(Path("bulk-created.json").read_text(encoding="utf-8"))["job"]["id"]
response = requests.get(
f"https://api.flashdata.dev/v2/bulk-jobs/{bulk_id}",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
Path("bulk-job.json").write_text(json.dumps(response.json(), indent=2), encoding="utf-8")
print(json.dumps(response.json()["job"], indent=2))python bulk_status.pyBULK_ID=$(jq -er '.job.id' bulk-created.json)
curl --fail-with-body --silent --show-error \
"https://api.flashdata.dev/v2/bulk-jobs/$BULK_ID" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--output bulk-job.json &&
jq '.job | {id, status, counts, pauseReason, error, expiresAt}' bulk-job.jsonBalasan
| Status HTTP | Arti |
|---|---|
| 200 | Bulk Work state |
| 401 | Pengesahan diperlukan atau tidak sah |
| 404 | Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon |
{
"$ref": "#/components/schemas/BulkJobResponse"
}Daftar pekerjaan
Tanggapannya mengandung data dan peginasi. Pass pagination.nextCursor **sebagai parameter pertanyaan kursor permintaan berikutnya sampai saat ini ** null. Batas penggunaan dari 1 Ke 50); baku adalah 20.
| Parameter | Lokasi | Keperluan Keperluan Kemurtadan |
|---|---|---|
| cursor | query | Pilihan · {"type":"string","maxLength":512} |
| limit | query | Pilihan · {"type":"integer","minimum":1,"maximum":50,"default":20} |
GET https://api.flashdata.dev/v2/bulk-jobs
X-API-Key: YOUR_API_KEYSimpan list_bulk_jobs.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
response = requests.get(
"https://api.flashdata.dev/v2/bulk-jobs?limit=20",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))python list_bulk_jobs.pycurl --fail-with-body --silent --show-error --max-time 30 \
--request GET \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
"https://api.flashdata.dev/v2/bulk-jobs?limit=20"Balasan
| Status HTTP | Arti |
|---|---|
| 200 | Halaman kerja Bulk |
| 401 | Pengesahan diperlukan atau tidak sah |
{
"$ref": "#/components/schemas/BulkJobPage"
}Jeda kerja
Jeda pengiriman baru dan pengiriman hasil. Pekerjaan yang telah ada berlanjut dengan pengaturan dan tuntutan asli mereka. Lanjutkan pekerjaan ketika siap.
| Parameter | Lokasi | Keperluan Keperluan Kemurtadan |
|---|---|---|
| bulkId | path | Wajib · {"type":"string","pattern":"^bulk_[A-Za-z0-9_-]{8,}$"} |
POST https://api.flashdata.dev/v2/bulk-jobs/{bulkId}/pause
X-API-Key: YOUR_API_KEYSimpan pause_bulk_job.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
bulk_id = json.loads(Path("bulk-created.json").read_text(encoding="utf-8"))["job"]["id"]
response = requests.post(
f"https://api.flashdata.dev/v2/bulk-jobs/{bulk_id}/pause",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))python pause_bulk_job.pyBULK_ID=$(jq -er '.job.id' bulk-created.json)
curl --fail-with-body --silent --show-error --max-time 30 \
--request POST \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
"https://api.flashdata.dev/v2/bulk-jobs/$BULK_ID/pause"Balasan
| Status HTTP | Arti |
|---|---|
| 200 | Jeda kerja besar atau keadaan idempoten saat ini |
| 401 | Pengesahan diperlukan atau tidak sah |
| 404 | Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon |
{
"$ref": "#/components/schemas/BulkJobResponse"
}Pilihan kerja update
Opsi pemutakhiran saat menunggu unggahan, atau sementara diistirahatkan sebelum semua masukan telah dibaca. Pekerjaan yang ada tetap menjaga pengaturan mereka. Jika berhenti masih dalam proses, tunggu dan coba lagi respon 409. Setelah semua masukan telah dibaca, hanya kelayakan pengiriman yang dapat diperbarui. callback_url ke null untuk menghapusnya.
Contoh ini menghilangkan pelengkapan callback. Untuk mengubah pilihan sumber, kirim sebuah pilihan objek sebagai gantinya. Jeda pertama dan tunggu jeda berlaku; sebuah 409 berarti pembaruan belum dapat diterapkan. Pekerjaan anak - anak yang telah ada tetap memiliki pilihan yang asli.
| Parameter | Lokasi | Keperluan Keperluan Kemurtadan |
|---|---|---|
| bulkId | path | Wajib · {"type":"string","pattern":"^bulk_[A-Za-z0-9_-]{8,}$"} |
PATCH https://api.flashdata.dev/v2/bulk-jobs/{bulkId}
X-API-Key: YOUR_API_KEYSimpan update_bulk_job.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
bulk_id = json.loads(Path("bulk-created.json").read_text(encoding="utf-8"))["job"]["id"]
response = requests.patch(
f"https://api.flashdata.dev/v2/bulk-jobs/{bulk_id}",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
json={"callback_url": None},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))python update_bulk_job.pyBULK_ID=$(jq -er '.job.id' bulk-created.json)
curl --fail-with-body --silent --show-error --max-time 30 \
--request PATCH \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Content-Type: application/json' --data '{"callback_url":null}' \
"https://api.flashdata.dev/v2/bulk-jobs/$BULK_ID"Sambutan dan permintaan skema
| Status HTTP | Arti |
|---|---|
| 200 | Status pekerjaan pukal yang baru dimutakhirkan |
| 401 | Pengesahan diperlukan atau tidak sah |
| 404 | Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon |
| 409 | Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan |
| 422 | Permintaan validasi quest gagal |
{
"$ref": "#/components/schemas/UpdateBulkJobRequest"
}{
"$ref": "#/components/schemas/BulkJobResponse"
}Kembali bekerja
Pertama-tama Fix pauseReason, seperti menambahkan kredit atau memperbarui kelayakan penyimpanan, kemudian melanjutkan Bulk ID yang sama.
| Parameter | Lokasi | Keperluan Keperluan Kemurtadan |
|---|---|---|
| bulkId | path | Wajib · {"type":"string","pattern":"^bulk_[A-Za-z0-9_-]{8,}$"} |
POST https://api.flashdata.dev/v2/bulk-jobs/{bulkId}/resume
X-API-Key: YOUR_API_KEYSimpan resume_bulk_job.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
bulk_id = json.loads(Path("bulk-created.json").read_text(encoding="utf-8"))["job"]["id"]
response = requests.post(
f"https://api.flashdata.dev/v2/bulk-jobs/{bulk_id}/resume",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))python resume_bulk_job.pyBULK_ID=$(jq -er '.job.id' bulk-created.json)
curl --fail-with-body --silent --show-error --max-time 30 \
--request POST \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
"https://api.flashdata.dev/v2/bulk-jobs/$BULK_ID/resume"Balasan
| Status HTTP | Arti |
|---|---|
| 200 | Keadaan kerja pukal saat ini |
| 401 | Pengesahan diperlukan atau tidak sah |
| 404 | Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon |
{
"$ref": "#/components/schemas/BulkJobResponse"
}¡Chardin a job
Hentikan pengiriman baru. Pekerjaan yang telah ada masih dapat finish dan tidak dapat menanggung tuntutan normal mereka. Tugas yang dibatalkan tidak menerbitkan manifes akhir.
| Parameter | Lokasi | Keperluan Keperluan Kemurtadan |
|---|---|---|
| bulkId | path | Wajib · {"type":"string","pattern":"^bulk_[A-Za-z0-9_-]{8,}$"} |
DELETE https://api.flashdata.dev/v2/bulk-jobs/{bulkId}
X-API-Key: YOUR_API_KEYSimpan cancel_bulk_job.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
bulk_id = json.loads(Path("bulk-created.json").read_text(encoding="utf-8"))["job"]["id"]
response = requests.delete(
f"https://api.flashdata.dev/v2/bulk-jobs/{bulk_id}",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))python cancel_bulk_job.pyBULK_ID=$(jq -er '.job.id' bulk-created.json)
curl --fail-with-body --silent --show-error --max-time 30 \
--request DELETE \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
"https://api.flashdata.dev/v2/bulk-jobs/$BULK_ID"Balasan
| Status HTTP | Arti |
|---|---|
| 200 | Keadaan kerja pukal saat ini |
| 401 | Pengesahan diperlukan atau tidak sah |
| 404 | Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon |
{
"$ref": "#/components/schemas/BulkJobResponse"
}Woindon mendapatkan hasil manifest
Ikut arah kembali untuk mengunduh manifes JSON dan gunakan link-nya untuk mengambil berkas hasil. Kutip signed penyimpanan URLs tanpa kunci API anda. Hasil hasil tes tetap tersedia untuk jam 24 setelah seluruh pekerjaan Bulk selesai.
Gagal disahkannya permintaan API mengembalikan 302 dengan header Lokasi. Kutip bahwa HTTPS penyimpanan URL dalam permintaan terpisah tanpa X-API-Key. Contoh ini menyelamatkan manifest.json. A 409 berarti hasil tidak siap; 410 berarti mereka sudah tamat.
| Parameter | Lokasi | Keperluan Keperluan Kemurtadan |
|---|---|---|
| bulkId | path | Wajib · {"type":"string","pattern":"^bulk_[A-Za-z0-9_-]{8,}$"} |
GET https://api.flashdata.dev/v2/bulk-jobs/{bulkId}/results
X-API-Key: YOUR_API_KEYSimpan bulk_manifest.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
bulk_id = json.loads(Path("bulk-created.json").read_text(encoding="utf-8"))["job"]["id"]
response = requests.get(
f"https://api.flashdata.dev/v2/bulk-jobs/{bulk_id}/results",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
if response.status_code != 302:
raise RuntimeError(f"Expected a manifest redirect, got {response.status_code}")
url = response.headers["Location"]
if not url.startswith("https://"):
raise ValueError("Expected an HTTPS storage URL")
manifest = requests.get(url, timeout=120) # No FlashData API key.
manifest.raise_for_status()
Path("manifest.json").write_text(json.dumps(manifest.json(), indent=2), encoding="utf-8")
print(json.dumps(manifest.json(), indent=2))python bulk_manifest.pyBULK_ID=$(jq -er '.job.id' bulk-created.json)
# Only send the API key to FlashData; fetch storage URLs separately.
fetch_bulk_result() {
local storage_url
storage_url=$(curl --fail-with-body --silent --show-error \
"https://api.flashdata.dev/v2/bulk-jobs/$BULK_ID/results$1" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--output /dev/null --write-out '%{redirect_url}') || return
curl --fail-with-body --silent --show-error --proto '=https' \
"${storage_url:?Expected a signed result URL}" --output "$2"
}
fetch_bulk_result '' manifest.json &&
jq '{status, counts, parts, expires_at}' manifest.jsonBalasan
| Status HTTP | Arti |
|---|---|
| 200 | Diunduh manifes JSON setelah mengikuti arah semula |
| 302 | Redirect ke swasta berumur pendek R2 URL; Kelayakan API tidak boleh diteruskan · Location |
| 401 | Pengesahan diperlukan atau tidak sah |
| 404 | Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon |
| 409 | Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan |
| 410 | Hasil yang terpaku telah berakhir |
{
"type": "object",
"additionalProperties": true
}Bagian hasil unduhan gandeng
Guna setiap parts[].number dari manifest.json. Setiap titik akhir end mengembalikan 302 ke berkas gzip NDJSON; download tanpa kunci API, dekompresi, kemudian parse one JSON objek per baris. Bergabung dengan indeks berbasis nol. Contoh itu mengambil semua bagian dan menyimpan kedua berkas .ndjson.gz dan .ndjson.
| Parameter | Lokasi | Keperluan Keperluan Kemurtadan |
|---|---|---|
| bulkId | path | Wajib · {"type":"string","pattern":"^bulk_[A-Za-z0-9_-]{8,}$"} |
| partNumber | path | Wajib · {"type":"integer","minimum":0} |
GET https://api.flashdata.dev/v2/bulk-jobs/{bulkId}/results/{partNumber}
X-API-Key: YOUR_API_KEYSimpan bulk_parts.py dalam pukal-api/ di samping bulk-created.json. Salin skrip lengkap, kemudian jalankan perintah di bawahnya.
import json
import os
from pathlib import Path
import requests
import gzip
import shutil
bulk_id = json.loads(Path("bulk-created.json").read_text(encoding="utf-8"))["job"]["id"]
manifest = json.loads(Path("manifest.json").read_text(encoding="utf-8"))
for part in manifest["parts"]:
number = part["number"]
response = requests.get(
f"https://api.flashdata.dev/v2/bulk-jobs/{bulk_id}/results/{number}",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
if response.status_code != 302:
raise RuntimeError(f"Expected a part redirect, got {response.status_code}")
url = response.headers["Location"]
if not url.startswith("https://"):
raise ValueError("Expected an HTTPS storage URL")
# Save the original gzip bytes; do not decompress twice.
with requests.get(url, stream=True, timeout=120) as download:
download.raise_for_status()
with open(f"part-{number}.ndjson.gz", "wb") as file:
download.raw.decode_content = False
shutil.copyfileobj(download.raw, file)
with gzip.open(f"part-{number}.ndjson.gz", "rt", encoding="utf-8") as rows:
with open(f"part-{number}.ndjson", "w", encoding="utf-8") as file:
for line in rows:
file.write(line)
print(json.dumps(json.loads(line)))python bulk_parts.pyBULK_ID=$(jq -er '.job.id' bulk-created.json)
# Only send the API key to FlashData; fetch storage URLs separately.
fetch_bulk_result() {
local storage_url
storage_url=$(curl --fail-with-body --silent --show-error \
"https://api.flashdata.dev/v2/bulk-jobs/$BULK_ID/results$1" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--output /dev/null --write-out '%{redirect_url}') || return
curl --fail-with-body --silent --show-error --proto '=https' \
"${storage_url:?Expected a signed result URL}" --output "$2"
}
fetch_bulk_result '' manifest.json &&
jq '{status, counts, parts, expires_at}' manifest.json
# Run in the same Bash session as fetch_bulk_result.
jq -r '.parts[].number' manifest.json | while IFS= read -r PART; do
fetch_bulk_result "/$PART" "part-$PART.ndjson.gz" || exit
gzip -dc "part-$PART.ndjson.gz" > "part-$PART.ndjson" || exit
jq -c '{index, video_id, status, results, error}' "part-$PART.ndjson"
doneBalasan
| Status HTTP | Arti |
|---|---|
| 200 | Terkompresi Gzip-Mode NDJSON download setelah mengikuti arah semula |
| 302 | Redirect ke swasta berumur pendek R2 URL; Kelayakan API tidak boleh diteruskan · Location |
| 401 | Pengesahan diperlukan atau tidak sah |
| 404 | Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon |
| 409 | Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan |
| 410 | Hasil yang terpaku telah berakhir |
{
"type": "string"
}¡Job negara bagian dan retensi
Hasil hasil tes tetap tersedia untuk jam 24 setelah seluruh pekerjaan Bulk selesai. Simpan mereka sebelum expiresAt. Media di tempat tujuanmu mengikuti kebijakan retensi embermu. Sebuah pekerjaan yang selesai dapat mencakup video yang gagal; catatan counts.invalid menolak input baris.
| Negara Bagian | Tindakan berikutnya |
|---|---|
| awaiting_upload | Upload file dan panggilan mulai. |
| running | ID dengan backoff yang sama; input.complete menunjukkan apakah pemindaian selesai. |
| paused | Baca pauseReason, perbaiki, lalu sambungkan lagi. |
| finalizing | Tunggu hasil kemasan dan publikasinya. |
| completed | Unduh manifes dan setiap bagian. Periksa status dan kesalahan setiap baris. |
| failed / cancelled | Periksa kesalahan dan keadaan tersimpan. Tidak ada manifes akhir diterbitkan. |
Pengiriman penyimpanan
Gunakan ruang uji untuk mengkonfigurasi penyedia dan melihat medan permintaan yang tepat. Kelayakan storan pelanggan perlu berada dalam objek storan yang dipilih; X-API-Key hanya mengesahkan permintaan API FlashData.
| Sumber | Buat bidang permintaan | Pengiriman |
|---|---|---|
| Data meta, transkrip, kapsi, cek lisensi | options.result_storage | Coaled. Salin bagian hasil NDJSON dan manifest ke ember Anda. |
| youtube_download | options.storage | Diperlukan. Media pengiriman ke ember Anda; result_storage dan browser_delivery tidak diterima. |
Cari file yang dikirimkan
manifest data ditulis terakhir dan mencantumkan kunci objek, ukuran dan SHA-256Q checksums. Ini berbeda dengan manifes FlashData, yang mencantumkan nilai horef API. OLEH YYYYMMDDD dalam jalur data menggunakan tanggal pembuatan UTC Bulk; dalam jalur media ia menggunakan tanggal unggah UTC masing-masing video. Pengiriman data Bulk OSS membutuhkan titik akhir aliyuncs.com.
Nilai file_url untuk media swasta untuk penyimpanan SDK atau URL yang ditandatangani dari penyedia tersebut. Kunci FlashData tidak memberikan akses ember. Berkas-berkas pendamping data metadata yang bersifat opsional telah disimpan di samping media. Retrie pengiriman muncul di delivery.retryCount.
<prefix>/<source>/<bulkId>/results/part-NNNNNNNN.jsonl.gz
<prefix>/<source>/<bulkId>/manifest.jsonIpar akan menerima pelengkapan webhook
Tempatkan HTTPS callback_url umum di luar pilihan. Pengiriman Bulk baru selesai setelah menerbitkan manifes; ia mengirimkan tidak ada acara per-video dan tidak ada acara penyelesaian untuk pekerjaan yang gagal atau dibatalkan. Tetap jajak pendapat status sebagai kemunduran.
- Keperatan dan deduplikasi delivery_id, kemudian kembali 2xx secara segera. Pengiriman sampai delapan kali dengan backoff.
- Peristiwa-peristiwa yang tidak ditandatangani. Hatch cocokkan id dan sumber ke penerimaan yang telah disimpan; verifikasi selesai melalui manajemen terotentikasi API sebelum queuing penerimaan kembali. Abaikan URLs dari kejadian yang belum diverifikasi.
{
"source": "youtube_metadata",
"options": {
"include_formats": false,
"include_chapters": false
},
"callback_url": "https://your-app.example/webhooks/flashdata"
}{
"delivery_id": "bulk-completion:bulk_EXAMPLE123",
"id": "bulk_EXAMPLE123",
"source": "youtube_metadata",
"status": "completed",
"links": [
{
"rel": "self",
"href": "https://api.flashdata.dev/v2/bulk-jobs/bulk_EXAMPLE123",
"method": "GET"
},
{
"rel": "results",
"href": "https://api.flashdata.dev/v2/bulk-jobs/bulk_EXAMPLE123/results",
"method": "GET"
}
]
}Definisi Schema sontak
BulkJobCreated
{
"type": "object",
"additionalProperties": false,
"required": [
"job",
"upload"
],
"properties": {
"job": {
"$ref": "#/components/schemas/BulkJob"
},
"upload": {
"type": "object",
"additionalProperties": false,
"required": [
"href",
"method",
"expiresAt",
"contentType"
],
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"const": "PUT"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"contentType": {
"type": "string",
"const": "text/plain; charset=utf-8"
}
}
}
}
}BulkJob
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"source",
"status",
"input",
"counts",
"delivery",
"pauseReason",
"error",
"createdAt",
"startedAt",
"completedAt",
"expiresAt",
"links"
],
"properties": {
"id": {
"type": "string",
"pattern": "^bulk_[A-Za-z0-9_-]{8,}$"
},
"source": {
"type": "string",
"enum": [
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_download"
]
},
"status": {
"type": "string",
"enum": [
"awaiting_upload",
"running",
"paused",
"finalizing",
"completed",
"failed",
"cancelled"
]
},
"input": {
"type": "object",
"additionalProperties": false,
"required": [
"bytes",
"complete",
"scannedBytes",
"scannedLines"
],
"properties": {
"bytes": {
"type": "integer",
"minimum": 0
},
"complete": {
"type": "boolean"
},
"scannedBytes": {
"type": "integer",
"minimum": 0
},
"scannedLines": {
"type": "integer",
"minimum": 0
}
}
},
"counts": {
"type": "object",
"additionalProperties": false,
"required": [
"accepted",
"completed",
"failed",
"invalid",
"results"
],
"properties": {
"accepted": {
"type": "integer",
"minimum": 0
},
"completed": {
"type": "integer",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"invalid": {
"type": "integer",
"minimum": 0
},
"results": {
"type": "integer",
"minimum": 0
}
}
},
"pauseReason": {
"type": [
"string",
"null"
]
},
"delivery": {
"type": "object",
"additionalProperties": false,
"required": [
"customerStorage",
"storageType",
"uploadedParts",
"retryCount"
],
"properties": {
"customerStorage": {
"type": "boolean"
},
"storageType": {
"type": [
"string",
"null"
],
"enum": [
"s3",
"s3_compatible",
"oss",
"gcs",
"azure",
"cos",
"bos",
"tos",
null
]
},
"uploadedParts": {
"type": "integer",
"minimum": 0
},
"retryCount": {
"type": "integer",
"minimum": 0
}
}
},
"error": {
"oneOf": [
{
"type": "null"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"code",
"detail"
],
"properties": {
"code": {
"type": "string"
},
"detail": {
"type": [
"string",
"null"
]
}
}
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"startedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobLink"
}
}
}
}BulkJobPage
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkJob"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}BulkJobResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/BulkJob"
}
}
}CreateBulkJobRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"source"
],
"properties": {
"source": {
"type": "string",
"enum": [
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_download"
]
},
"options": {
"type": "object",
"additionalProperties": true,
"description": "Reused for every ID. Metadata accepts include_formats and include_chapters. Transcript and captions accept language (one code or an array of 1–10 distinct codes) and auto (applies to all requested languages). Omit language to prefer en-orig, fall back to en, and return one track. With auto=true, each requested code tries its -orig track first, then the plain code. Explicit -orig codes and auto=false stay exact. languageCode identifies the selected track; requestedLanguageCode is included when it differs from the requested code. A language array returns tracks and per-language errors for each video with at least one retrieved track. If no track is retrieved, the video job fails and its reserved credits are refunded. Bulk exports use one JSONL record per video. Trainability accepts no source options. These four data sources optionally accept result_storage. Supported storage_type values are s3, s3_compatible, oss, gcs, azure, cos, bos, and tos. storage_url is the bucket name (Azure container name); object_prefix is optional. S3, S3-compatible, OSS, COS, BOS, and TOS use access_key and secret_key. S3-compatible and OSS also require a public HTTPS endpoint_url. COS, BOS, and TOS require region and use fixed provider endpoints. COS bucket names include the APPID. BOS S3-compatible HTTPS delivery supports bj, su, and hkg. GCS requires service_account with project_id, client_email, and private_key. Azure requires account_name and a container SAS sas_token with write permission. Default object_prefix is YYYYMMDD, frozen to the UTC bulk creation date. Files are written to <prefix>/<source>/<bulkId>/results/part-NNNNNNNN.jsonl.gz; manifest.json in the same bulk directory is written last. Each JSONL row includes its input index and completed, failed, or invalid status. Internal R2 results remain available through the result links for 24 hours. Download accepts the normal YouTube download parameters, requires customer storage, and does not permit browser_delivery. Download storage supports the same eight provider types and credential shapes listed above under the storage field. Download storage may include object_prefix; YYYYMMDD tokens resolve to the UTC upload date, while literal prefixes are unchanged."
},
"callback_url": {
"type": "string",
"format": "uri",
"maxLength": 2048,
"description": "Optional public HTTPS endpoint notified once after manifest publication."
}
}
}JobLink
{
"type": "object",
"additionalProperties": false,
"required": [
"rel",
"href",
"method"
],
"properties": {
"rel": {
"type": "string",
"enum": [
"self",
"results",
"content",
"download"
]
},
"href": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"const": "GET"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"filename": {
"type": "string"
},
"content_type": {
"type": "string"
},
"size_bytes": {
"type": "integer",
"minimum": 1
}
}
}Pagination
{
"type": "object",
"additionalProperties": false,
"required": [
"hasMore",
"limit"
],
"properties": {
"nextCursor": {
"type": [
"string",
"null"
]
},
"previousCursor": {
"type": [
"string",
"null"
]
},
"hasMore": {
"type": "boolean"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
}Problem
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"properties": {
"type": {
"type": "string",
"format": "uri-reference"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": 400,
"maximum": 599
},
"code": {
"type": "string",
"pattern": "^[a-z0-9_]+$"
},
"detail": {
"type": "string"
},
"requestId": {
"type": "string",
"pattern": "^req_"
},
"fieldErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldError"
}
}
}
}FieldError
{
"type": "object",
"additionalProperties": false,
"required": [
"field",
"code",
"message"
],
"properties": {
"field": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}UpdateBulkJobRequest
{
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"options": {
"type": "object",
"additionalProperties": true,
"description": "Partial option update. Nested storage fields are merged so unchanged credentials do not need to be resent. Data result_storage fields are merged the same way. After all IDs have been scanned, a paused data bulk job accepts credential updates only: access_key and secret_key, GCS service_account, or Azure sas_token, depending on the storage type. The complete merged configuration is validated before it is stored."
},
"callback_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 2048,
"description": "Replacement completion callback, or null to remove the callback."
}
}
}