दस्तावेज़ देखें
शुरू करें
अपनी पहली Google खोज चलाएँ और ऐप या AI एजेंट के लिए संरचित परिणाम पाएँ।
अपने AI एजेंट से शुरू करें
यह प्रॉम्प्ट ऐसे एजेंट को दें जिसके पास टर्मिनल का एक्सेस हो। वह 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 सहेजें।