Обзор документации
Начало работы
Выполните первый поиск Google и получите структурированные результаты для приложения или ИИ-агента.
Начните с вашего ИИ-агента
Передайте этот промпт агенту с доступом к терминалу. Он настроит FlashData и выполнит один поиск.
Прочитайте https://flashdata.dev/auth.md и выполните инструкции по настройке FlashData для этой среды. Повторно используйте существующий доступ; если его нет, начните только один пробный период при соблюдении условий. Найдите в Google "battery recycling research", запросив не более пяти результатов. Верните названия источников, URL и фактически потраченные кредиты. Храните учётные данные в защищённом хранилище, а не в чате. Если доступ заблокирован, укажите следующий шаг вместо создания нового пробного периода.
Выполните первый вызов API
Хотите написать код сами? Выполните эти три шага в терминале.
Получите API-ключ
Создайте аккаунт, подтвердите почту и создайте ключ с разрешением Google Search. Если такой ключ уже есть, используйте его.
Выполните команду в терминале и вставьте ключ в запрос со скрытым вводом. Пропустите шаг, если FLASHDATA_API_KEY уже задана.
Задайте ключ# Bash: paste the key into a hidden prompt, not into this command. read -r -s -p "FlashData API key: " FLASHDATA_API_KEY printf '\n' export FLASHDATA_API_KEYЗадайте ключ# PowerShell 7: paste the key into a hidden prompt. $flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString $env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password Remove-Variable flashdataSecureKeyВыполните поиск
Выберите язык и запустите пример в том же терминале. Каждый запуск отправляет один поисковый запрос.
Python 3.10+ · Сохраните пример как quickstart.py.
Установитьpython -m pip install "flashdata==1.1.0"quickstart.pyimport json import os from flashdata import FlashData with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client: response = client.google.search("battery recycling research", num=5) if response["status"] != "done": raise RuntimeError(response) print(json.dumps(response, indent=2))Запуститьpython quickstart.pyNode.js 22.18+ · Начните в пустой папке и сохраните quickstart.mts.
Настроитьnpm init -y npm install --save-exact @flashdata-dev/[email protected]quickstart.mtsimport { FlashData } from '@flashdata-dev/sdk'; const apiKey = process.env.FLASHDATA_API_KEY; if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.'); const client = new FlashData({ apiKey }); const response = await client.google.search({ query: 'battery recycling research', num: 5, }); if (response.status !== 'done') throw new Error(JSON.stringify(response)); console.log(JSON.stringify(response, null, 2));Запуститьnode quickstart.mtsNode.js 22+ · Начните в пустой папке и сохраните quickstart.mjs.
Настроитьnpm init -y npm install --save-exact @flashdata-dev/[email protected]quickstart.mjsimport { FlashData } from '@flashdata-dev/sdk'; const apiKey = process.env.FLASHDATA_API_KEY; if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.'); const client = new FlashData({ apiKey }); const response = await client.google.search({ query: 'battery recycling research', num: 5, }); if (response.status !== 'done') throw new Error(JSON.stringify(response)); console.log(JSON.stringify(response, null, 2));Запуститьnode quickstart.mjsGo 1.25+ · Начните в пустой папке и сохраните main.go. Пропустите go mod init в существующем модуле.
Настроитьgo mod init example.com/flashdata-quickstart go get github.com/flashdatadev/[email protected]main.gopackage main import ( "context" "encoding/json" "log" "os" "time" flashdata "github.com/flashdatadev/flashdata-go" ) func main() { key := os.Getenv("FLASHDATA_API_KEY") if key == "" { log.Fatal("Set FLASHDATA_API_KEY through your server's secret manager.") } client, err := flashdata.New(flashdata.Options{APIKey: key}) if err != nil { log.Fatal(err) } ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute) defer cancel() result, err := client.Google.Search(ctx, flashdata.GoogleSearchInput{ Query: "battery recycling research", Params: &flashdata.GoogleSearchParams{Num: flashdata.Ptr(int64(5))}, }) if err != nil { // Do not automatically resubmit an uncertain paid request. log.Fatal(err) } if err := json.NewEncoder(os.Stdout).Encode(result); err != nil { log.Fatal(err) } if result.Status != "done" { log.Fatalf("Search did not complete: %s", result.Status) } }Запуститьgo run .SDK не нужен. Выполните команду Bash / cURL 7.76+ или PowerShell 7.
Bash / cURLcurl --fail-with-body --silent --show-error \ --request POST https://data.flashdata.dev/v1/queries/realtime \ --header "X-API-Key: $FLASHDATA_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"source":"google_search","query":"battery recycling research","params":{"num":5}}'PowerShell 7$flashdataRequest = '{"source":"google_search","query":"battery recycling research","params":{"num":5}}' $flashdataResult = Invoke-RestMethod -Method Post -Uri 'https://data.flashdata.dev/v1/queries/realtime' -Headers @{ 'X-API-Key' = $env:FLASHDATA_API_KEY } -ContentType 'application/json' -Body $flashdataRequest $flashdataResult | ConvertTo-Json -Depth 20Проверьте результат
Успешный ответ содержит status: done. Источники находятся в results[].organic, списанные кредиты — в usage.credits.
Пример ответа (сокращённый){ "status": "done", "results": [ { "organic": [ { "title": "Battery recycling research", "link": "https://example.org/recycling", "snippet": "An example search excerpt." } ] } ], "usage": { "credits": 0.02 } }
Попробуйте консоль
- Создайте аккаунт или войдите. Подтвердите почту и выполните шаги настройки аккаунта, показанные в консоли.
- Откройте Google Search, выберите источник Google Search и режим Realtime, затем введите battery recycling research. Разверните Additional parameters и задайте Page size (num) равным 5.
- Проверьте показанный запрос и доступные кредиты, затем выполните поиск один раз.
- Проверьте ответ и расход. Откройте полученный источник, чтобы проверить его содержание, прежде чем цитировать что-либо за пределами отрывка.
Развивайте первый результат
Если первый запрос не удался
- Не задана FLASHDATA_API_KEY
- Задайте ключ в том же терминале или среде, где запускаете пример. Эти фрагменты не загружают файлы .env.
- 401 / 403
- Проверьте, что ключ или подключение активно и имеет разрешение google_search.
- 402
- Проверьте доступные кредиты в Billing. Привяжите существующий пробный доступ к аккаунту, если нужен доступ владельца.
- 429
- Соблюдайте Retry-After. Сохраните ту же идентичность и доказательство регистрации; не создавайте новый пробный доступ.
- Тайм-аут или неизвестный статус отправки
- Перед повтором проверьте существующий запуск. В CLI сохраните тот же профиль и ID запуска; в SDK/API сохраните полученный ID задания или запроса.