Dokumentation durchsuchen
Erste Schritte
Führen Sie Ihre erste Google-Suche aus und erhalten Sie strukturierte Ergebnisse für Ihre Anwendung oder Ihren KI-Agenten.
Starten Sie mit Ihrem KI-Agenten
Geben Sie diesen Prompt an einen Agenten mit Terminalzugriff. Er richtet FlashData ein und führt eine Suche aus.
Lies https://flashdata.dev/auth.md und befolge die FlashData-Einrichtungsschritte für diese Umgebung. Verwende vorhandenen Zugriff erneut; falls keiner vorhanden ist, starte höchstens einen Testzugang, sofern du berechtigt bist. Suche bei Google nach "battery recycling research" mit höchstens fünf Ergebnissen. Gib Quellentitel, URLs und tatsächlich verbrauchte Credits zurück. Bewahre Zugangsdaten in einem geschützten Speicher auf, niemals im Chat. Wenn der Zugriff blockiert ist, nenne den nächsten Schritt, statt einen weiteren Testzugang anzulegen.
Ersten API-Aufruf ausführen
Sie möchten den Code selbst schreiben? Folgen Sie diesen drei Schritten im Terminal.
API-Schlüssel erstellen
Erstellen Sie ein Konto, bestätigen Sie Ihre E-Mail-Adresse und erstellen Sie einen Schlüssel mit Google-Search-Berechtigung. Ein vorhandener Schlüssel kann wiederverwendet werden.
Führen Sie den Befehl im Terminal aus und fügen Sie Ihren Schlüssel in die verdeckte Eingabe ein. Überspringen Sie diesen Schritt, wenn FLASHDATA_API_KEY bereits gesetzt ist.
Schlüssel setzen# 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_KEYSchlüssel setzen# 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 flashdataSecureKeySuche ausführen
Wählen Sie Ihre Programmiersprache und führen Sie das Beispiel im selben Terminal aus. Jede Ausführung sendet eine Suche.
Python 3.10+ · Speichern Sie das Beispiel als quickstart.py.
Installierenpython -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))Ausführenpython quickstart.pyNode.js 22.18+ · Beginnen Sie in einem leeren Ordner und speichern Sie quickstart.mts.
Einrichtennpm 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));Ausführennode quickstart.mtsNode.js 22+ · Beginnen Sie in einem leeren Ordner und speichern Sie quickstart.mjs.
Einrichtennpm 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));Ausführennode quickstart.mjsGo 1.25+ · Beginnen Sie in einem leeren Ordner und speichern Sie main.go. Überspringen Sie go mod init in einem vorhandenen Modul.
Einrichtengo 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) } }Ausführengo run .Kein SDK erforderlich. Führen Sie entweder den Befehl für Bash / cURL 7.76+ oder für PowerShell 7 aus.
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 20Ergebnis prüfen
Eine erfolgreiche Antwort enthält status: done. Die Quellen stehen in results[].organic, das verbrauchte Guthaben in usage.credits.
Beispielantwort (gekürzt){ "status": "done", "results": [ { "organic": [ { "title": "Battery recycling research", "link": "https://example.org/recycling", "snippet": "An example search excerpt." } ] } ], "usage": { "credits": 0.02 } }
Konsole ausprobieren
- Erstellen Sie ein Konto oder melden Sie sich an. Bestätigen Sie Ihre E-Mail-Adresse und schließen Sie die in der Konsole angezeigten Einrichtungsschritte ab.
- Öffnen Sie Google Search, wählen Sie die Quelle Google Search und den Modus Realtime und geben Sie battery recycling research ein. Öffnen Sie Additional parameters und setzen Sie Page size (num) auf 5.
- Prüfen Sie die angezeigte Anfrage und Ihr verfügbares Guthaben. Führen Sie die Suche dann einmal aus.
- Prüfen Sie Antwort und Verbrauch. Öffnen Sie eine zurückgegebene Quelle, bevor Sie mehr als ihren Auszug zitieren.
Mit dem ersten Ergebnis weiterarbeiten
Wenn die erste Anfrage fehlschlägt
- FLASHDATA_API_KEY fehlt
- Setzen Sie den Schlüssel im selben Terminal oder in derselben Laufzeitumgebung wie das Beispiel. Diese Beispiele laden keine .env-Dateien.
- 401 / 403
- Prüfen Sie, ob der Schlüssel oder die Verbindung aktiv ist und über die Berechtigung google_search verfügt.
- 402
- Prüfen Sie Ihr verfügbares Guthaben unter Billing. Verknüpfen Sie einen vorhandenen Testzugang, wenn Kontoinhaberzugriff erforderlich ist.
- 429
- Beachten Sie Retry-After. Behalten Sie dieselbe Identität und denselben Registrierungsnachweis bei; erstellen Sie keinen weiteren Testzugang.
- Zeitüberschreitung oder unklarer Übermittlungsstatus
- Prüfen Sie die vorhandene Ausführung vor einem erneuten Versuch. CLI-Nutzer behalten Profil und Ausführungs-ID bei; SDK/API-Nutzer bewahren jede zurückgegebene Job- oder Anfrage-ID auf.