Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Довідник API

Інструменти та схеми MCP

Переглядайте аргументи FlashData MCP, за замовчуванням, читання облікових записів, робочі стани та результат ретривал.

На цій сторінці

Версія Markdown

OAuth, Codex, OpenClaw і API-key параметри доступу

Оберіть Ваш клієнт MCP і підключення

Транспорт та автентифікація

У готелі MCP кінцева точка використовує потоковий HTTP. API-підключення під ключ X-API-Key; доступ до інструменту слідувати за дозволами на джерело ключа та наявними кредитами.

Помилки HTTP
URL: https://data.flashdata.dev/mcp
X-API-Key: <your API key>

Зберігати свій реальний FlashData API ключ в обліковій конфігурації клієнта. Не ставити його в розмову або аргументи інструментів. Цей розділ охоплює підключення API-підключення; керівництво агента охоплює OAuth логін і тестовані конфігурації Codex і OpenClaw. youtube_download підтримує асинхронні медіа завантаження з відповідним дозволом API-key.

Керування ключами API

Інструменти для запитів

Ваш клієнт відкриває інструменти, надані ключем. Всі шість Google і вісім YouTube інструментів даних за замовчуванням в режимі реального часу, а також приймає mode: async. submit_batch підтримує обидві групи. youtube_download використовує формальне завантаження API, вимагає зберігання клієнтів, а також підтримує роботу з async або 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"
}

Повідомлень інструменту

Поставляйте поля запиту, такі як запиту, ну, мова та режим безпосередньо у об’єкті аргументів інструмента, без параметра REST API. Назва запиту вибирає джерело; тільки записи в submit_batch потребують джерело. API ключі і callback_url не є аргументами інструментів. Приклади JSON нижче є аргументними об'єктами для client.callTool({ name, аргументи). }

Використовуйте JSON booleans і цілих чисел, не рядків. Невідомі поля відхилені. Про нас 14 інструменти запиту даних приймають mode: realtime or async, за замовчуванням в режимі реального часу. Batch записів не приймають режим.

КОМПЛЕКСОбов’язковоДодаткові аргументи та за замовчуванням
youtube_downloadvideo_id, storageрежим підтримує асинхронізацію тільки (default). 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 (default)/webm/mkv для відео, m4a (default)/mp3/opus для аудіо. audio_language: default/original; audio_quality: best/320/256/192/128, аудіо тільки. yt_dlp_format: до 1024 персонажі, наділені якості, fps і вибір мови. Оміт video_quality/fps для аудіо та audio_language для відео-тільки. зберігання потрібно і відповідає Завантажити API params.storage. start_at/end_at: HH:MM: SS, до 12 час; end_at обов'язково слідувати start_at. upload_metadata: boolean, за замовчуванням false. Кожен пакет для завантаження потреб зберігання. No 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: дволеттерна країна; hl: 1–35 код мови; location/tbs: 1–200 символи; num/page: цілі 1–100; autocorrect: 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Омітувати мову, щоб віддати перевагу ен-оріг, потім введіть, повертаємо один трек. За допомогою авто=true кожен код віддає перевагу своєму треку -оріг, після чого звичайний код; явний -оріг і авто=false залишаються точними. Намагатися всіх 1–10 запитані мови та помилки в порядку. автоматично за замовчуванням true для автоматичних запонок.
youtube_captionsvideo_idОмітувати мову, щоб віддати перевагу ен-оріг, потім введіть, повертаємо один трек. За допомогою авто=true кожен код віддає перевагу своєму треку -оріг, після чого звичайний код; явний -оріг і авто=false залишаються точними. Намагатися всіх 1–10 запитані мови та помилки в порядку. автоматично за замовчуванням false для завантажувачів-повідомлень.
youtube_trainabilityvideo_idНемає додаткових аргументів, крім режиму. Звіти про класифікацію ліцензії Creative Commons; не надає дозволу на навчання.
youtube_channelhandleручка: 1–100; video_limit: 1–100, за замовчуванням 20.
youtube_suggestionsqueryзапит: 1–2, 000; мова: за замовчуванням; область: дволеттерний код країни, за замовчуванням US.

video_id є 11-character 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, 3д, 4к, creative_commons, hd, hdr, жити, розташування, придбаний, субтитри, 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 байтів); завантажує резерв Кредит і врегулювати фактичні завантажені байти. request_count не застосовується для завантаження і estimatedCredits є null.

get_usage from/to повинен бути UTC ISO таймери, такі як 2026-09-21T00:00:00Z, додатково з 1–3 дробових других цифр. від інклюзивного, до ексклюзивного, округленого до хвилини. За замовчуванням вікно 7 днів і максимальна - 31 днів. З тільки від, до сім днів пізніше; з тільки до, від 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"
}

Робота і великі результати

Заява про те, що компанія job_id до get_job для читання job.status. У комплекті роботи входить оригінальна відповідь запитів на запити в виході. Для завантаження видається завантаження: output.results[0].file_url точки для зберігання клієнтів, з file_size, downloaded_bytes і md5. Приватні файли вимагають автентичності вашого сховища. JSON зберігає для 24 годин; збереження та доступу до політики зберігання даних. submit_batch приймає принаймні одну 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, за замовчуванням 16000, вимірюваний в UTF-16 код одиниць замість байтів або рядків результату. Конкатенувати шматки для того, щоб до припарювання JSON; next_offset=null відзначає кінець. Результати кешуються для 10 хвилин, з більшістю чотирьох великих результатів за ключ, і може бути скорочений. Читання штанів не повторює запит або сплачує кредити.

get_result · аргументи JSON
{
  "result_id": "result_1800000000000_00000000-0000-0000-0000-000000000000",
  "offset": 16000,
  "limit": 16000
}

Billing і помилки

Запитання щодо використання кредитного договору з використанням тарифних планів, які не відповідають вимогам стандарту MCP. Набір помилок інструменту isError і зберігають потік HTTP статус і запит ID. Відновити кредити на недостатній баланс і перевірити ключові дозволи на помилки доступу.

Часовий або втрачений з'єднання не означає, що запит не був виконаний. Для query_outcome_unknown перевірте запит History в консолі перед тим, як викинути, щоб подати знову. Не можна автоматично переробляти оплачені уявлення; дані наявних робочих місць або шматків можуть бути перероблені. Відповіді на Upstream обмежені 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();
}