Przeglądaj dokumentację
Dokumentacja API
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ź | Accept | X-Respond-With | Zastosowanie |
|---|---|---|---|
| JSON | application/json | Omit | Pole partycji w kodzie · domyślnie |
| JSON + Markdown | application/json | markdown | Kontekst agenta z metadanymi strukturyzowanymi |
| Prosty tekst | text/plain | Omit | Czytanie oryginalnych pól w terminalu |
| Tekst + Markdown | text/plain | markdown | Odczyt 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.
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"}'{
"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"
}Czytać zawartość jako łańcuch Markdown. Zastępuje wyniki; źródło, status i wykorzystanie pozostają dostępne jako pola JSON.
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' \
--header 'X-Respond-With: markdown' \
--data '{"source":"google_search","query":"vector databases"}'{
"source": "google_search",
"status": "done",
"usage": {
"credits": 0.01
},
"created_at": "2026-10-22T12:00:00.000Z",
"content": "# Google search\n\n## Organic\n\n### 1. Example page\n\n**Link:** <https://example.com/article>\n\n**Snippet:** A short source snippet\\.\n"
}Przeczytaj odpowiedź jako tekst. Zawiera oryginalne pola w wciętym układzie, a nie dokument JSON.
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: text/plain' \
--data '{"source":"google_search","query":"vector databases"}'Source: "google_search"
Status: "done"
Results:
1:
Organic:
1:
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"
Przeczytaj odpowiedź jako tekst: metadane najpierw, a następnie zawartość Markdown.
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: text/plain' \
--header 'X-Respond-With: markdown' \
--data '{"source":"google_search","query":"vector databases"}'Source: "google_search"
Status: "done"
Usage: {"credits":0.01}
Created at: "2026-10-22T12:00:00.000Z"
Markdown Content:
# Google search
## Organic
### 1. Example page
**Link:** <https://example.com/article>
**Snippet:** A short source snippet\.
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ńcowy | JSON / zwykły tekst | Zawartość Markdown |
|---|---|---|
| POST /v1/queries/realtime | Obsługiwane | Obsługiwane |
| GET /v2/jobs/{id}/results | Obsługiwane | Obsługiwane |
| POST /v1/queries | Odbiór zgłoszenia | Ignorowane - wybrać go podczas odczytu wyników |
| POST /v1/queries/batch | Odbiór zgłoszenia | Ignorowane - wybrać go podczas odczytu wyników |
| GET /v2/jobs/{id} | Status miejsca pracy | Ignorowane - 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 format | Reakcja na wyniki |
|---|---|
| Original JSON | 302 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 Markdown | 200 z sformatowanym ciałem bezpośrednio w odpowiedzi. |
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 / kod | Napraw |
|---|---|
| 400 · unsupported_representation | Użyj X-Respond-With: markdown lub pomiń nagłówek. Wartości takie jak json lub tekst nie są obsługiwane. |
| 406 · not_acceptable | Uż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ź.
Accept: text/plain; charset=utf-8, application/json;q=0.8