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

Dokumentacja API

Formaty odpowiedzi

Wybierz ustrukturyzowany JSON dla aplikacji lub zawartość Markdown dla agenta AI. Kontroluj reakcję dwoma nagłówkami.

Na tej stronie

Wybierz format

JSON z oryginalnymi polami wyników jest domyślny. Accept wybiera JSON lub zwykły tekst; X-Respond-With: markdown konwertuje zawartość wyniku na Markdown. Twoje ciało zostaje JSON.

OdpowiedźAcceptX-Respond-WithZastosowanie
JSONapplication/jsonOmitPole partycji w kodzie · domyślnie
JSON + Markdownapplication/jsonmarkdownKontekst agenta z metadanymi strukturyzowanymi
Prosty teksttext/plainOmitCzytanie oryginalnych pól w terminalu
Tekst + Markdowntext/plainmarkdownOdczyt metadanych i Markdown razem

Przykłady wniosków i odpowiedzi

Te karty pokazują ten sam Google Search w każdym formacie. Użyj Bash i cURL 7.76 + z ustawieniem FLASHDATA_API_KEY na klucz umożliwiający google_search. Prowadzenie komendy wymaga jednego bilingu.

Domyślnie. Przeanalizuj tablicę wyników; pola wewnątrz niej zależą od źródła.

Wniosek · cURL / Bash
curl --fail-with-body --silent --show-error \
  'https://data.flashdata.dev/v1/queries/realtime' \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"source":"google_search","query":"vector databases"}'
Przykład odpowiedzi · wartości ilustrujące
{
  "source": "google_search",
  "status": "done",
  "results": [
    {
      "organic": [
        {
          "title": "Example page",
          "link": "https://example.com/article",
          "snippet": "A short source snippet."
        }
      ]
    }
  ],
  "usage": {
    "credits": 0.01
  },
  "created_at": "2026-10-22T12:00:00.000Z"
}

Obsługiwane punkty końcowe

Te same zasady stosuje się do źródeł zapytania Google Search i YouTube. Dla YouTube Download formatują one zapis dostawy, a nie wideo lub bajty audio. API kont, manifesty Bulk i części NDJSON, zwroty i odpowiedzi MCP używają własnych formatów.

Punkt końcowyJSON / zwykły tekstZawartość Markdown
POST /v1/queries/realtimeObsługiwaneObsługiwane
GET /v2/jobs/{id}/resultsObsługiwaneObsługiwane
POST /v1/queriesOdbiór zgłoszeniaIgnorowane - wybrać go podczas odczytu wyników
POST /v1/queries/batchOdbiór zgłoszeniaIgnorowane - wybrać go podczas odczytu wyników
GET /v2/jobs/{id}Status miejsca pracyIgnorowane - brak zawartości rezultatu

Format zakończonego zadania

Ustaw nagłówki podczas odczytywania wyniku, nawet jeśli ustawisz je na poddanie. Ustaw JOB_ID na ukończone zadanie, do którego możesz uzyskać dostęp. Ten GET odczytuje istniejące wyniki bez składania kolejnego zapytania.

Wymagany formatReakcja na wyniki
Original JSON302 z podpisaną pamięcią URL w lokalizacji. Pobierz URL oddzielnie, bez X-API-Key. Wyniki przechowywane mogą być skompresowane gzip-.
Zwykły tekst lub opcja Markdown200 z sformatowanym ciałem bezpośrednio w odpowiedzi.
Pobieranie Markdown wewnątrz JSON · cURL / Bash
curl --fail-with-body --silent --show-error \
  "https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}/results" \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json' \
  --header 'X-Respond-With: markdown'

Błąd formatowania

Błędy API pozostają błędami JSON lub application/problem+json, nawet jeśli wymagają one zwykłego tekstu. Sprawdź status HTTP przed przejściem do formatu sukcesu.

Stan / kodNapraw
400 · unsupported_representationUżyj X-Respond-With: markdown lub pomiń nagłówek. Wartości takie jak json lub tekst nie są obsługiwane.
406 · not_acceptableUżyj Accept: application/json lub text/plain. text/markdown i application/xml nie są obsługiwane.

Szczegóły nagłówka Accept

Omit Accept lub wysłać * / *, aby otrzymać JSON. Odpowiedzi należy użyć UTF-8. Obsługiwane są zakresy medialne i wagi q; nieobsługiwany Charset zwraca 406, chyba że inny akceptowalny zakres pasuje. Content-Type: application/json opisuje organ wnioskujący, a nie odpowiedź.

Preferencyjny tekst, niech JSON
Accept: text/plain; charset=utf-8, application/json;q=0.8