Jelajahi dokumentasi
Referensi API
Alat dan skema MCP
Lihat ke atas FlashData MCP argumen alat, baku, akun baca, tugas negara dan hasil pengambilan.
Di halaman ini
OAuth, Codex, OpenClaw dan pilihan akses kunci API-
Pilih klien MCP anda dan hubungkan
Transportasi dan otentikasi
Endpoint MCP yang diselenggarakan menggunakan Streamable HTTP. Koneksi kunci API-mengirim koneksi X-API-Key; akses alat mengikuti hak sumber kunci dan kredit yang tersedia.
URL: https://data.flashdata.dev/mcp
X-API-Key: < Anda API kunci >Simpan kunci FlashData API anda yang sebenarnya dalam konfigurasi kredensial klien. Jangan memasukkannya ke dalam sebuah percakapan atau argumen alat. Bagian ini meliputi API-key koneksi; sampul panduan akses agen OAuth login dan teruji Codex dan OpenClaw konfigurasi. youtube_download Mendukung pengunduhan media asinkron dengan yang sesuai API-key izin.
Kelola kunci APIPerkakas kuiri
Klienmu menemukan alat yang diberikan oleh kuncinya. Semua enam Google dan delapan YouTube data baku ke realtime dan juga menerima mode: async. submit_batch mendukung kedua grup. youtube_download menggunakan unduhan formal API, membutuhkan penyimpanan pelanggan, dan mendukung pekerjaan async atau submit_batch. Model dapat memilih dan menggabungkan alat untuk tugas ini.
google_search · google_images · google_news · google_shopping · google_videos · google_places
YouTube
youtube_search · youtube_search_extended · youtube_metadata · youtube_transcript · youtube_captions · youtube_trainability · youtube_channel · youtube_suggestions · youtube_download
{
"query": "MCP protocol",
"num": 3,
"gl": "us",
"hl": "en",
"mode": "async"
}Perkakas argumen
Tempatkan ruas query seperti query, num, bahasa dan mode langsung dalam objek argumen alat, tanpa REST API's params pembungkus. Sebuah alat query 's nama memilih sumbernya; hanya entri dalam submit_batch membutuhkan sumber. kunci API dan callback_url bukan tool argumen. Contoh JSON di bawah ini adalah obyek argumen untuk client.callTool ({name, argument}).
Gunakan JSON bool dan bilangan integer, bukan string. Bidang tak dikenal ditolak. Perkakas pencarian data 14 menerima mode: realtime atau async, default ke realtime. Masukan Batch tidak menerima mode.
| Alat | Wajib | Argumen opsional & baku |
|---|---|---|
youtube_download | video_id, storage | mode hanya mendukung async (baku). download_type: audio_video (bawaan)/video/audio. video_quality: <=720 secara baku; best/worst atau < =, = =, > = dengan 144/360/480/720/1080/1440/2160/4320. fps: perbandingan yang sama dengan 1–240. output_format: mp4 (baku)/webm/mkv untuk video, m4a (baku)/mp3/opus untuk audio. audio_language: default/original; audio_quality: best/320/256/192/128, hanya audio. yt_dlp_format: sampai ke 1024 karakter, overrides kualitas, fps dan pilihan bahasa. Omit video_quality/fps untuk audio dan audio_language untuk penyimpanan video- only. dibutuhkan dan cocok Unduh API params.storage. start_at/end_at: SS, sampai 12 jam; end_at harus mengikuti start_at. upload_metadata: boolean, baku false. Setiap batch download membutuhkan penyimpanan. Tidak ada browser_delivery atau callback_url. |
storage | storage_type, storage_url | storage_url adalah nama bucket Anda (Azure: kontainer), bukan direktori lokal. storage_type: s3/s3_compatible/oss/gcs/azure/cos/bos/tos; opsional object_prefix. S3, S3-kompatibel, OSS, COS, BOS dan TOS gunakan access_key/secret_key dengan yang bisa diterapkan region/endpoint_url. GCS menggunakan service_account (project_id, client_email, private_key); Azure menggunakan account_name dan sebuah kontainer sas_token dengan izin menulis. Titik akhir harus dapat dicapai dari Pekerja. Baca kredensial dari konfigurasi penyimpanan Anda; jangan menempelkannya ke percakapan atau echo mereka. |
google_* | query | query: 1–2,000 Karakter. Gl: dua negara huruf; hl: 1–35 kode bahasa karakter; location/tbs: 1–200 karakter; num/page: integer 1–100; autobenar: boolean. Opsi yang diijinkan menggunakan perilaku penyedia pencarian, tanpa negara tetap, bahasa atau hasil dijamin. |
youtube_search | query | query: 1–2, 000 karakter. max_results: 1–20 baku 20; penyaring: objek filter, diabaikan atau null untuk tidak ada penyaring. |
youtube_search_extended | query | query: 1–2, karakter 000. max_results: 1–700, baku 20; penyaring: sama dengan pencarian standar. |
youtube_metadata | video_id | include_formats dan include_chapters: bootans, keduanya true baku. |
youtube_transcript | video_id | Abaikan bahasa untuk lebih memilih en-orig, kemudian en, kembali satu trek. Dengan auto = true, setiap kode lebih memilih trek -orig, maka kode polos; eksplisit -orig dan auto = false tetap tepat. Array mencoba semua 1–10 meminta bahasa dan kembali trek dan kesalahan dalam rangka. Otomatis default ke true untuk captions otomatis. |
youtube_captions | video_id | Abaikan bahasa untuk lebih memilih en-orig, kemudian en, kembali satu trek. Dengan auto = true, setiap kode lebih memilih trek -orig, maka kode polos; eksplisit -orig dan auto = false tetap tepat. Array mencoba semua 1–10 meminta bahasa dan kembali trek dan kesalahan dalam rangka. Otomatis default ke false untuk uphagg- disediakan captions. |
youtube_trainability | video_id | Tidak ada argumen opsional kecuali mode. Laporan Creative Commons lisensi klasifikasi, tidak memberikan izin pelatihan. |
youtube_channel | handle | handle: 1–100 karakter; video_limit: 1–100, baku 20. |
youtube_suggestions | query | query: 1–2, karakter 000; bahasa: default en; daerah: dua huruf kode negara, baku US. |
video_id adalah 11-character YouTube ID menggunakan huruf, angka, garis bawah atau tanda hubung; menyediakan ID daripada video URL. Setiap kode bahasa adalah karakter 1–35 menggunakan huruf, angka, atau tanda hubung. Untuk subtitel, auto = true memilih takarir otomatis dan false memilih upsider yang disediakan, tanpa mundur otomatis di antara mereka. Untuk arrays bahasa, memeriksa kesalahan bahkan ketika pekerjaan berhasil.
YouTube penyaring pencarian
filters.type: video/channel/playlist/movie; upload_date: today/last_hour/this_week/this_month/this_year; durasi: <4, 4-20 atau >20; sort_by: rating/relevance/view_count/upload_date. Flag fitur adalah bool; true memerlukan fitur tersebut: 360, 3d, 4k, creative_commons, hd, hidup, lokasi, dibeli, subtitle, vr180.
{
"query": "renewable energy",
"max_results": 5,
"filters": {
"type": "video",
"duration": "<4",
"subtitles": true
}
}Pandangan akun (bebas)
get_balance membaca saldo rekening bersama Anda; get_pricing memperkirakan biaya pertanyaan; get_limits membaca batas rencana dan pekerjaan yang tertunda saat ini; get_usage meringkas terakhir 7 hari secara baku, dengan maksimum 31-hari jendela. Penggunaan termasuk semua kunci akun bagi sumber yang diijinkan oleh kunci pemanggilan dan mungkin tertunda.
get_balance dan get_limits take {}. get_pricing menerima sebuah sumber opsional; abaikan itu untuk semua MCP sumber query yang disahkan oleh kunci Anda. request_count adalah sebuah integer dari 1 ke 100000, baku 1; setiap halaman atau butir batch dihitung sebagai permintaan terpisah. get_usage menerima sumber opsional; abaikan untuk semua sumber yang berwenang. Termasuk penggunaan youtube_download. Download pricing returns creditsPerTb (1 TB = 10 ^ 12 bytes); unduhan Credit cadangan dan selesaikan dengan byte yang diunggah. request_count tidak berlaku untuk pengunduhan dan estimatedCredits adalah null.
get_usage from/to harus berupa penanda waktu ISO UTC seperti 2026-09-21T00:00: 00Z, mungkin dengan 1–3 fractional kedua dimit. dari inklusif, untuk eksklusif, dibulatkan ke menit. Jendela baku adalah hari 7 dan maksimum adalah hari 31. Dengan hanya dari, ke tujuh hari kemudian, dengan hanya, dari tujuh hari sebelumnya. Baca respon from/to untuk jendela efektif.
{
"source": "google_search",
"request_count": 3
}{
"source": "youtube_metadata",
"from": "2026-09-21T00:00:00Z",
"to": "2026-09-22T00:00:00Z"
}Pekerjaan dan hasil besar
Permintaan async mengembalikan id pekerjaan; lulus sebagai job_id ke get_job untuk membaca job.status. Pekerjaan yang selesai termasuk respon pencarian asli dalam keluaran. Untuk diunduh, keluaran adalah daftar unggahan: output.results [0]. file_url menunjuk ke penyimpanan pelanggan, dengan file_size, downloaded_bytes dan md5. Berkas pribadi membutuhkan otentikasi penyimpanan Anda. JSON hasil dipertahankan untuk 24 jam; penahanan media dan akses mengikuti kebijakan penyimpanan Anda. submit_batch paling tidak menerima satu Google atau YouTube query (termasuk pengunduhan), dengan sumber dan argumen rata pada setiap entri. Setiap entri ditagih secara terpisah, dan rencana Anda batch dan batas tertunda berlaku. Membaca pekerjaan tidak mengisi biaya lagi. Bulk berbasis berkas bukan alat MCP.
Memproses berkas ID? Gunakan Bulk HTTP API
{
"video_id": "FUfGcZ092b0",
"language": "en",
"auto": true,
"mode": "async"
}{
"queries": [
{
"source": "google_search",
"query": "renewable energy",
"num": 3
},
{
"source": "youtube_metadata",
"video_id": "FUfGcZ092b0",
"include_formats": false
}
]
}Ganti contoh job_id, result_id dan offset dengan nilai dari tanggapan Anda. Baca potongan berikutnya tanpa mengirimkan kembali query.
{
"job_id": "job_REPLACE_WITH_RETURNED_ID"
}Tanggapan besar termasuk potongan teks JSON, result_id dan next_offset. Call get_result dengan kunci yang sama dan yang dikembalikan result_id. ofset adalah sebuah integer nonnegatif, baku 0; gunakan sebelumnya next_offset untuk terus. batas adalah integer dari 1 ke 16000, baku 16000(Dan ditutup pula) diselimuti pula (oleh kegelapan) dan kepekatan yang menghitam.16 satuan kode daripada bytes atau baris hasil. Konkatenasi potongan dalam rangka sebelum parsing JSON; next_offset = null menandai akhir. Hasil yang cache untuk 10 menit, dengan paling banyak empat hasil besar per kunci, dan mungkin diusir lebih cepat. Membaca potongan tidak mengulangi permintaan atau biaya Credits.
{
"result_id": "result_1800000000000_00000000-0000-0000-0000-000000000000",
"offset": 16000,
"limit": 16000
}Billing dan errors
Kueri menggunakan harga rencana Anda yang ada Credits tanpa tambahan MCP biaya. Galat peralatan telah mengatur isError dan pertahankan arus hulu status HTTP dan permintaan ID. Kembalikan Credits untuk keseimbangan yang tidak mencukupi dan periksa perizinan kunci untuk kesalahan akses.
Tenggat waktu atau koneksi hilang tidak berarti query tidak dijalankan. Untuk query_outcome_unknown, periksa Permintaan History di konsol sebelum memutuskan untuk mengirimkan lagi. Jangan coba lagi pengiriman berbayar; baca dari pekerjaan yang sudah ada atau potongan dapat dicoba kembali. Respon upstream terbatas pada 4 MiB, jadi batasi ukuran pencarian; respon terlalu besar mungkin sudah diisi.
Verifikasi dengan klien JavaScript
Klien ini menggunakan pejabat yang diverifikasi SDK 1.30.0 untuk menyambung melalui Streamable HTTP dan daftar alat tanpa menjalankan kueri berbayar. Simpan sebagai mcp-check.mjs, set FLASHDATA_API_KEY di lingkungan anda, kemudian jalankan titik mcp-check.mjs.
npm install @modelcontextprotocol/[email protected]import { Client } from '@modelcontextprotocol/sdk/client/index.js';
import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js';
const key = process.env.FLASHDATA_API_KEY;
if (!key) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new Client({ name: 'my-app', version: '1.0.0' });
try {
await client.connect(new StreamableHTTPClientTransport(
new URL('https://data.flashdata.dev/mcp'),
{ requestInit: { headers: { 'X-API-Key': key } } }
));
console.log((await client.listTools()).tools.map(tool => tool.name));
} finally {
await client.close();
}