Przejdź do treści
PL
Uzyskaj klucz API
Przeglądaj dokumentację

Dokumentacja API

Narzędzia i schematy MCP

Sprawdź argumenty narzędzi FlashData MCP, domyślnie, odczyty konta, stany pracy i pobieranie wyników.

Na tej stronie

Wersja Markdown

OAuth, Codex, OpenClaw i opcje dostępu klucza API-

Wybierz klienta MCP i podłącz

Transport i uwierzytelnianie

W punkcie końcowym, w którym znajduje się produkt MCP, stosuje się produkt Streamable HTTP. API- połączenia klawiszy wysyłają X-API-Key; dostęp do narzędzi następuje po uprawnieniach źródłowych klucza i dostępnych kredytów.

Streamable HTTP
URL: https://data.flashdata.dev/mcp
X-API-Key: < Twój klucz API >

Aktualny klucz FlashData API należy przechowywać w konfiguracji kredytowej klienta. Nie umieszczaj tego w dyskusjach ani w argumentach dotyczących narzędzi. Niniejsza sekcja obejmuje: API-kluczowe połączenia; przewodnik dostępu agenta obejmuje OAuth logowanie i testowane Codex oraz OpenClaw konfiguracje. youtube_download obsługuje asynchroniczne pobieranie nośników z odpowiednim API- Kluczowe pozwolenie.

Zarządzanie kluczami API

Narzędzia do zapytania

Twój klient odkrywa narzędzia przyznane przez klucz. Wszystkie sześć narzędzi danych Google i osiem narzędzi YouTube domyślnych do rzeczywistego czasu, a także akceptują mode: async. submit_batch obsługuje obie grupy. youtube_download używa formalnej wersji Download API, wymaga przechowywania danych klienta i obsługuje zadania azynkowe lub submit_batch. Model może wybrać i połączyć narzędzia do zadania.

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 · argumenty JSON
{
  "query": "MCP protocol",
  "num": 3,
  "gl": "us",
  "hl": "en",
  "mode": "async"
}

Argumenty narzędzia

Umieść pola zapytania, takie jak zapytanie, num, język i tryb bezpośrednio w obiekcie argumentów narzędzia, bez opakowania paramów REST API. Nazwa narzędzia zapytania wybiera swoje źródło; tylko wpisy w submit_batch potrzebują źródła. Klucze API i callback_url nie są argumentami narzędzi. Poniżej znajdują się przykłady JSON dla client.callTool ({nazwa, argumenty}).

Użyj numerów boolendów JSON i liczb całkowitych, a nie ciągów. Nieznane pola są odrzucane. Narzędzia do zapytania danych 14 akceptują mode: realtime lub async, nie wykonując zadań w czasie rzeczywistym. Wpisy Batch nie akceptują trybu.

NarzędzieWymaganeOpcjonalne argumenty i domyślne
youtube_downloadvideo_id, storagemode obsługuje tylko async (domyślnie). download_type: audio_video (domyślnie)/video/audio. video_quality: <=720 domyślnie; best/worst lub < =, = =, > = z 144/360/480/720/1080/1440/2160/4320. fps: te same porównania z 1–240. output_format: mp4 (domyślnie)/webm/mkv dla wideo, m4a (domyślnie)/mp3/opus dla dźwięku. audio_language: default/original; audio_quality: best/320/256/192/128, tylko audio. yt_dlp_format: do 1024 znaki, nadwyższa jakość, fps i wybór języka. Omit video_quality/fps dla audio i audio_language dla wideo-ony. pamięci jest wymagane i pasuje do pobrania API params.storage. start_at/end_at: HH: MM: SS, do 12 godzin; end_at musi być zgodny z start_at. upload_metadata: boolean, domyślnie false. Każda partia do pobrania wymaga przechowywania. Brak browser_delivery lub callback_url.
storagestorage_type, storage_urlstorage_url to nazwa twojego pojemnika (Azure: container), a nie lokalny katalog. storage_type: s3/s3_compatible/oss/gcs/azure/cos/bos/tos; opcjonalne object_prefix. S3, S3- kompatybilny, OSS, COS, BOS i TOS stosować access_key/secret_key z odpowiednim region/endpoint_url. GCS wykorzystuje service_account (project_id, client_email, private_key); Azure używa account_name i kontenera sas_token za pozwoleniem na pisanie. Punkt końcowy musi być osiągalny z workera. Przeczytaj referencje z konfiguracji pamięci masowej; nie wklej ich do czatu lub echa.
google_*queryZapytanie: 1–2, 000 criteria. gl: dwuliterowy kraj; hl: 1–35 znaków kod języka; location/tbs: znaków 1–200; num/page: liczb całkowitych 1–100; autopoprawny: boolean. Zatwierdzone opcje wykorzystują zachowanie dostawcy wyszukiwania, bez gwarantowanego stałego kraju, języka lub liczby wyników.
youtube_searchqueryZapytanie: 1–2, znaki 000. max_results: 1–20, domyślnie 20; filtry: obiekt filtrujący, pominięty lub null dla żadnych filtrów.
youtube_search_extendedqueryZapytanie: 1–2, znaki 000. max_results: 1–700, domyślnie 20; filtry: takie same jak standardowe wyszukiwanie.
youtube_metadatavideo_idinclude_formats i include_chapters: boologne, obydwa domyślne true.
youtube_transcriptvideo_idOmit język preferować en- orig, a następnie en, zwracając jeden utwór. Z auto = true, każdy kod preferuje swój utwór -orig, a następnie prosty kod; wyraźny -orig i auto = false pozostają dokładne. Array wypróbować wszystkie języki wymagane 1–10 i wrócić utworów i błędów w zamówieniu. auto domyślnie true dla automatycznego podpisków.
youtube_captionsvideo_idOmit język preferować en- orig, a następnie en, zwracając jeden utwór. Z auto = true, każdy kod preferuje swój utwór -orig, a następnie prosty kod; wyraźny -orig i auto = false pozostają dokładne. Array spróbuj wszystkich języków żądanych 1–10 i powrót utworów i błędów w zamówieniu. auto domyślnie false dla podpisy dostarczane przez uploader- dostarczane.
youtube_trainabilityvideo_idBrak opcjonalnych argumentów poza mode. Zwraca klasyfikację licencji Creative Commons; nie udziela zgody na trenowanie modelu.
youtube_channelhandleuchwyt: znaki 1–100; video_limit: 1–100, domyślnie 20.
youtube_suggestionsqueryquery: 1–2, 000 characters; language: default en; region: two-letter country code, default US.

video_id jest 11- znak YouTube ID za pomocą liter, liczb, podkreśleń lub myślników; dostarczyć ID zamiast wideo URL. Każdy kod językowy to znaki 1–35 za pomocą liter, liczb lub hyphenów. W przypadku napisów auto = true wybiera automatyczne podpisy, a false wybiera podpisy dostarczane przez uploader- dostarczone, bez żadnych automatycznych zwrotów pomiędzy nimi. W przypadku tablic językowych należy sprawdzić błędy nawet w przypadku sukcesu zadania.

Filtry wyszukiwania YouTube

filters.type: video/channel/playlist/movie; upload_date: today/last_hour/this_week/this_month/this_year; czas trwania: <4, 4-20 lub >20; sort_by: rating/relevance/view_count/upload_date. Flagi są boolends; true wymaga tej funkcji: 360, 3d, 4k, creative_commons, hd, hdr, live, lokalizacja, zakupione, napisy, vr180.

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

Uwagi dotyczące rachunku (za darmo)

get_balance odczytuje saldo Twojego konta współdzielonego; get_pricing szacuje koszty zapytania; get_limits odczytuje limity planu i bieżące zadania oczekujące na rozpatrzenie; get_usage podsumowuje domyślnie ostatnie dni 7, z maksymalnym oknem 31- dniowym. Zastosowanie zawiera wszystkie klucze konta dla źródeł autoryzowanych przez klucz wywoławczy i może być opóźnione.

get_balance i get_limits podejmują {}. get_pricing akceptuje opcjonalne źródło; pomija go dla wszystkich źródeł zapytania MCP autoryzowanych przez Twój klucz. request_count jest liczbą całkowitą od 1 do 100000, domyślnie 1; każda strona lub element wsadowy liczy się jako odrębny wniosek. get_usage akceptuje opcjonalne źródło; omit dla wszystkich autoryzowanych źródeł. Obejmuje użycie youtube_download. Pobieranie zwrotów cen creditsPerTb (1 TB = 10 ^ 12 bajtów); pobieranie rezerw Kredyty i rozliczenia przez rzeczywiste wysłane bajty. request_count nie dotyczy pobierania i estimatedCredits jest null.

get_usage from/to muszą być znacznikami czasu UTC ISO, takimi jak 2026-09- 21T00: 00: 00Z, opcjonalnie z ułamkowymi cyframi wtórnymi 1–3. Od inclusive, do wyłączności, zaokrąglona w dół do minut. Domyślne okno to 7 dni, a maksymalne to 31 dni. Tylko od, do jest siedem dni później, a tylko do, od jest siedem dni wcześniej. Przeczytaj odpowiedź from/to dla efektywnego okna.

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

Miejsca pracy i duże wyniki

Async request zwraca identyfikator zadania; podaje go jako job_id do get_job, aby przeczytać job.status. Wykonane zadania obejmują pierwotną odpowiedź na zapytanie w wyjściu. W przypadku pobierania, wyjście jest manifestem wysyłania: output.results [0] .file_url wskazuje na przechowywanie klienta, z file_size, downloaded_bytes i md5. Prywatne pliki wymagają uwierzytelniania pamięci. Wyniki JSON są zatrzymywane dla godzin 24; zatrzymywanie mediów i dostęp są zgodne z zasadami przechowywania danych. submit_batch akceptuje co najmniej jedno zapytanie Google lub YouTube (w tym pobieranie danych), z argumentami źródłowymi i płaskimi na każdym wpisie. Każdy wpis jest rozliczany oddzielnie, a plan partii i oczekujących limitów zastosowanie. Czytanie prac nie jest już naładowane. File- based Bulk nie jest narzędziem MCP.

Przetwarzanie pliku ID? Użyj Bulk HTTP API

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

Zastąp przykład job_id, result_id i offset wartościami z odpowiedzi. Przeczytaj następny kawałek bez ponownego podania zapytania.

get_job · argumenty JSON
{
  "job_id": "job_REPLACE_WITH_RETURNED_ID"
}

Do dużych odpowiedzi zalicza się kawałek tekstu JSON, result_id i next_offset. Zadzwoń do get_result z tym samym kluczem i zwróconym result_id. offset jest nienegatywną liczbą całkowitą, domyślnie 0; użyj poprzedniego next_offset do kontinu. limit jest liczbą całkowitą z 1 do 16000, domyślnie 16000, mierzoną w jednostkach kodu UTF- 16, a nie bajtów lub wierszy rezultatu. Zbierz kawałki w kolejności przed parsowaniem JSON; next_offset = null oznacza koniec. Wyniki są buforowane przez protokół 10, z co najwyżej czterema dużymi wynikami na klucz, i mogą być eksmitowane wcześniej. Odczyt fragmentów nie powtarza zapytania ani nie ładuje Kredytów.

get_result · argumenty JSON
{
  "result_id": "result_1800000000000_00000000-0000-0000-0000-000000000000",
  "offset": 16000,
  "limit": 16000
}

Billing i błędy

Zapytania korzystają z istniejących kredytów planu cen bez dodatkowych opłat MCP. Błędy narzędzi ustaw isError i zachowaj status HTTP na początku i zażądaj ID. Przywróć Kredyty dla niewystarczającej równowagi i sprawdź kluczowe uprawnienia dla błędów dostępu.

Czas lub utracone połączenie nie oznacza, że zapytanie nie zostało wykonane. Dla query_outcome_unknown, sprawdź żądanie History w konsoli przed podjęciem decyzji o ponownym przekazaniu. Nie należy automatycznie ponownie próbować płatnych zgłoszeń; odczyty istniejących miejsc pracy lub fragmentów mogą być ponownie próbowane. Odpowiedzi w górę są ograniczone do 4 MiB, więc limit rozmiar wyszukiwania; nadmierne odpowiedzi mogą być już naładowane.

Kody statusu HTTP · Zasady dotyczące retriów

Weryfikuj za pomocą klienta JavaScript

Klient ten używa zweryfikowanego oficjalnego SDK 1.30.0 do łączenia się ze Streamable HTTP i narzędzi listy bez wykonywania zapytania płatnego. Zapisz jako mcp-check.mjs, ustaw FLASHDATA_API_KEY w środowisku, a następnie uruchom węzeł 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();
}