コンテンツへスキップ
JA
APIキーを取得する
ドキュメントを探す

API リファレンス

MCP ツールとスキーマ

FlashData MCP ツールの引数、デフォルト、アカウントの読み込み、ジョブの状態、および結果の検索結果を表示します。

このページの内容

Markdown 版

OAuth、Codex、OpenClaw、APIキーアクセスオプション

MCPクライアントを選択し、接続

輸送および認証

ホストされているMCPエンドポイントは、HTTPのストリーム可能値を使用します。 APIキー接続は、X-API-Keyを送信します。ツールアクセスは、キーのソース権限と利用可能なクレジットに従います。

ストリーミング可能なHTTP
URL: https://data.flashdata.dev/mcp
X-API-Key: <your API キー>

クライアントのクレデンシャル設定で、実際のFlashData APIキーを保存します。 会話やツールの引数に置かないでください。 このセクションでは、APIキー接続をカバーします。エージェントアクセスガイドは、OAuthログインとテストされたCodexとOpenClaw構成をカバーしています。 youtube_downloadは、適切なAPIキーパーミッションで非同期メディアのダウンロードをサポートしています。

APIキーの管理

クエリツール

クライアントは、キーによって付与されたツールを発見します。 全部 6 Google と 8 YouTube リアルタイムでデータツールのデフォルトで、また受け入れる mode: async. submit_batch 両方のグループをサポートしています。 youtube_download 正式なダウンロードを使用する API、顧客記憶を要求し、そして非同期の仕事を支えて下さいまたは submit_batch. モデルは、タスクのツールを選択し、組み合わせることができます。

Google

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

google_search・引数 JSON
{
  "query": "MCP protocol",
  "num": 3,
  "gl": "us",
  "hl": "en",
  "mode": "async"
}

ツールの引数

クエリ、num、言語、モードなどのクエリフィールドを、REST API のパラメータラッパーなしで、ツールの引数オブジェクトに直接入れます。 クエリツールの名前は、そのソースを選択します。 submit_batch のソースのみのエントリ。 APIキーとcallback_urlはツール引数ではありません。 以下の JSON の例は、client.callTool({名、引数 }) の引数オブジェクトです。

文字列ではなく、JSON booleans と整数を使用してください。 未知のフィールドは拒否されます。 14のデータクエリツールは、mode: realtimeまたは非同期、デフォルトでリアルタイムに使用できます。 Batch エントリーは受け付けません。

ツール必須オプションの引数とデフォルト
youtube_downloadvideo_id, storageモードは非同期のみ(デフォルト)をサポートしています。 download_type: audio_video (デフォルト)/video/audio. video_quality: <=720 デフォルトでは; best/worst または <=, ==, >= と 144/360/480/720/1080/1440/2160/4320. fps: 同じ比較 1–240. output_format: mp4 (デフォルト)/webm/mkv ビデオの場合、m4a (デフォルト)/mp3/opus オーディオ用。 audio_language: default/original; audio_quality: best/320/256/192/128、音声だけ。 yt_dlp_format: まで 1024 キャラクター、品質、fps、言語選択を上書き。 Omit video_quality/fps for オーディオとaudio_language for Video-only. ストレージが必要とマッチ ダウンロード API params.storage. start_at/end_at: HH:MM:SS、12時間まで; end_atは、start_atに従う必要があります。 upload_metadata: boolean、デフォルト falseQQQQQQQ。 一括ダウンロードにはストレージが必要です。 browser_deliveryかcallback_url無し。
storagestorage_type, storage_urlstorage_urlは、ローカルディレクトリではなく、バケット名(Azure:コンテナ)です。 storage_type: s3/s3_compatible/oss/gcs/azure/cos/bos/tos; 任意object_prefix。 S3、S3互換、OSS、COS、BOS、TOSはaccess_key/secret_keyを該当するregion/endpoint_url.で使用 GCSはservice_account (project_id、client_email、private_key)を使用します; Azureは、account_nameとコンテナsas_tokenを書き込み権限で使用しています。 エンドポイントは、ワーカーから到達可能でなければなりません。 保存設定から認証情報を読みます。チャットに貼り付けたり、エコーしたりしないでください。
google_*queryクエリ: 1–2,000 文字。 gl: 2 文字の国; hl: 1–35 文字の言語コード; location/tbs: 1–200 文字; num/page: インテガーズ 1–100; 自動修正: boolean。 省略されたオプションは、検索プロバイダの動作を使用し、固定国、言語、または結果のカウントが保証されていません。
youtube_searchqueryクエリ: 1–2,000 文字。 max_results: 1–20、デフォルト 20; フィルター: フィルター オブジェクト、省略または null フィルターなし。
youtube_search_extendedqueryクエリ: 1–2,000 文字。 max_results: 1–700、デフォルト 20; フィルター:標準検索と同じ。
youtube_metadatavideo_idinclude_formats と include_chapters: booleans は、デフォルト true です。
youtube_transcriptvideo_idエンオリグを好む言語を省略し、エントして、1つのトラックを返します。 auto=true では、各コードは -orig のトラックを好みます、そして明白なコード; explicit -orig および auto=false は厳密な滞在します。 Arraysは、すべての1–10の要求された言語を試し、順番にトラックとエラーを返します。 自動キャプション用のtrueへの自動デフォルト。
youtube_captionsvideo_idエンオリグを好む言語を省略し、エントして、1つのトラックを返します。 auto=true では、各コードは -orig のトラックを好みます、そして明白なコード; explicit -orig および auto=false は厳密な滞在します。 Arraysは、すべての1–10の要求された言語を試し、順番にトラックとエラーを返します。 アップロード機能付きのキャプション用のfalseへの自動デフォルト。
youtube_trainabilityvideo_idモードを除くオプションの引数はありません。 クリエイティブ・コモンズのライセンス分類を報告し、トレーニングの許可を付与しません。
youtube_channelhandleハンドル: 1–100 文字; video_limit: 1–100、デフォルト 20。
youtube_suggestionsqueryクエリ: 1–2,000 文字; 言語: デフォルト en; 領域: 2 文字の国コード、デフォルト US。

video_id は、 11-キャラクター YouTube ID 手紙、数字、アンダースコア、ハイフンを使って;供給して下さい ID ビデオではなく URL. 各言語コードは、文字、数字、ハイフンを使って、1–35文字です。 字幕では、オート=true は自動キャプションと false は、アップローダーが付与されたキャプションを選択し、それらの間に自動フォールバックはありません。 言語配列の場合、ジョブが成功してもエラーをチェックします。

YouTube検索フィルタ

filters.type:video/channel/playlist/movie;upload_date:today/last_hour/this_week/this_month/this_year;持続期間:<4、4-20か>20;sort_by:rating/relevance/view_count/upload_date. 特徴の旗はボリアンです; trueは、その機能を必要とします: 360、3d、4k、creative_commons、HD、HD、HD、ライブ、場所、購入、字幕、vr180。

youtube_search・引数 JSON
{
  "query": "renewable energy",
  "max_results": 5,
  "filters": {
    "type": "video",
    "duration": "<4",
    "subtitles": true
  }
}

アカウントのインサイト(無料)

get_balance は共有アカウント残高を読み取ります。 get_pricing はクエリコストを推定します。 get_limits は、プランの制限と現在の保留ジョブを読み込みます。 get_usage は、デフォルトでは最後の 7 日を合計し、最大 31-day ウィンドウで動作します。 使用法は、呼び出しキーによって承認されたソースのすべてのアカウントキーを含み、遅延する可能性があります。

get_balance とりあえず get_limits お問い合わせ {}. get_pricing オプションのソースを受け付けます。すべてのソースを省略します。 MCP クエリソースは、キーによって認証されます。 request_count からの整数です。 1 へ へ へ へ 100000デフォルト 1; 各ページまたはバッチ項目は別々の要求としてカウントします。 get_usage オプションのソースを受け付けます。すべての認証されたソースに対して省略します。 youtube_downloadの使い方は含まれています。 プライシング・リターンのダウンロード creditsPerTb (1 TB = 10^12 bytes; アップロードされた実際のバイトによって、リザーブクレジットをダウンロードし、決済します。 request_count ダウンロードには適用されません。 estimatedCredits は、 null.

get_usage from/to UTC ISO のタイムスタンプである必要があります。 2026-09-21T00:00任意:00Z、 1–3 フラクショナルセカンド数字。 から 包括的、排他的に、数分間丸められます。 デフォルトウィンドウは7の日数で、最大値は31の日数です。 7日前から7日前まで、7日前まで。 有効なウィンドウの応答のfrom/toを読んで下さい。

get_pricing・引数 JSON
{
  "source": "google_search",
  "request_count": 3
}
get_usage・引数 JSON
{
  "source": "youtube_metadata",
  "from": "2026-09-21T00:00:00Z",
  "to": "2026-09-22T00:00:00Z"
}

仕事と大きな結果

async リクエストはジョブ ID を返します。job_id を get_job に渡して job.status を読みます。 完了したジョブは、元のクエリ応答を出力に含めます。 ダウンロードのために、出力はアップロードマニフェストです:output.results[0].file_urlポイントを顧客ストレージに、file_size、downloaded_bytes、およびmd5で。 プライベートファイルには、保存認証が必要です。 JSON 結果は 24 時間のために保持されます。メディアの保持とアクセスは、ストレージポリシーに従います。 submit_batch は、各エントリのソースとフラット引数で、少なくとも 1 つの Google または YouTube クエリ(ダウンロードを含む)を受け入れます。 各エントリーは別々に請求され、プランのバッチと上限が適用されます。 ジョブの読み込みは、再び課金されません。 ファイルベースのBulkはMCPツールではありません。

IDファイルを処理する? Bulk HTTP APIを使用して下さい

youtube_transcript・引数 JSON
{
  "video_id": "FUfGcZ092b0",
  "language": "en",
  "auto": true,
  "mode": "async"
}
submit_batch・引数 JSON
{
  "queries": [
    {
      "source": "google_search",
      "query": "renewable energy",
      "num": 3
    },
    {
      "source": "youtube_metadata",
      "video_id": "FUfGcZ092b0",
      "include_formats": false
    }
  ]
}

job_id、result_id、およびオフセットを、応答から値に置き換えます。 クエリを返しせずに次のチャンクを読みます。

get_job・引数 JSON
{
  "job_id": "job_REPLACE_WITH_RETURNED_ID"
}

JSONテキストチャンク、result_id、next_offsetなどの大きな応答があります。 コールセンター get_result 同じキーと返されたキーを使って result_id. オフセットは非負の整数、デフォルトです 0; 前の使用 next_offset 続行する。 制限は整数から 1 へ へ へ へ 16000デフォルト 16000UTF-で測定される、16 バイトや結果の行ではなく、コード単位。 JSONを解析する前に、チャンクを連結します。 next_offset=nullQは、最後にマークします。 結果は、10分にキャッシュされ、キーごとに最大4つの大きな結果が得られ、より早く悪用される可能性があります。 読み込みのチャンクは、クエリを繰り返すか、クレジットを充電しません。

get_result・引数 JSON
{
  "result_id": "result_1800000000000_00000000-0000-0000-0000-000000000000",
  "offset": 16000,
  "limit": 16000
}

Billingとエラー

Queries は既存のプランのクレジット価格設定を、MCP の追加料金なしで使用しています。 ツールのエラーは、isErrorを設定し、上流HTTPの状態を保持し、IDを要求します。 不十分な残高のクレジットを復元し、アクセスエラーの重要な権限を確認します。

タイムアウトや紛失した接続は、クエリが実行されていないという意味ではありません。 query_outcome_unknown では、再度送信する決定を行う前に、コンソールで History をリクエストします。 有料の投稿を自動的に再試行しないでください。既存のジョブやチャンクの読み込みが取得できます。 上流応答は4 MiBに限られているため、検索サイズを制限します。 特大応答は既に請求されている可能性があります。

HTTP ステータスコードの読み込み · 再試行ルール

JavaScriptクライアントで確認

このクライアントは、検証済みの公式のSDK 1.30.0を使用して、ストリーミング可能なHTTPとリストツールを経由して有料のクエリを実行せずに接続します。 mcp-check.mjsとして保存し、環境にFLASHDATA_API_KEYを設定し、ノードmcp-check.mjsを実行します。

npmの特長
npm install @modelcontextprotocol/[email protected]
mcp-check.mjsの特長
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();
}