दस्तावेज़ देखें
API संदर्भ
जवाब में परिणाम प्राप्त करें, या नौकरी जमा करें और उन्हें बाद में पुनः प्राप्त करें। कैसे अपने आवेदन या एजेंट काम के लिए इंतजार कर रहे हैं चुनें।
इस पेज पर
एक अनुरोध मोड चुनें
Google Search और YouTube Data दोनों मोडों का समर्थन करते हैं। YouTube Download को async, Batch या Bulk की आवश्यकता होती है; यह वास्तविक समय का समर्थन नहीं करता है। स्रोत पैरामीटर वास्तविक समय से async पर स्विच करते समय समान रहते हैं।
| मोड | कब उपयोग करें | आपको क्या प्राप्त होता है |
|---|---|---|
| Realtime | वर्तमान बातचीत में एक खोज परिणाम की आवश्यकता होती है। | उसी HTTP प्रतिक्रिया में परिणाम शरीर। |
| Async | आपकी प्रक्रिया डिस्कनेक्ट होने के बाद काम जारी रखना चाहिए, या आप मीडिया डाउनलोड कर रहे हैं। | एक नौकरी ID तुरंत; स्थिति और परिणाम अलग से प्राप्त करें। |
Realtime POST data.flashdata.dev/v1/queries/realtime → परिणाम
Async POST data.flashdata.dev/v1/queries → काम ID
GET api.flashdata.dev/v2/jobs/{id} → स्थिति
GET api.flashdata.dev/v2/jobs/{id}/results → परिणामएक अनुरोध भेजें
FLASHDATA_API_KEY को एक कुंजी में सेट करें जो google_search को अनुमति देता है। वास्तविक समय या async चुनें; प्रत्येक प्रस्तुतीकरण एक बिलेबल खोज चलाता है। एक ही नए काम करने वाले फ़ोल्डर में स्क्रिप्ट, रसीद और परिणाम रखें।
Python उदाहरण Python 3.10+ और अनुरोधों का उपयोग करते हैं। प्रत्येक स्क्रिप्ट स्वतंत्र रूप से चलती है और पहले के चरणों से सहेजी गई फ़ाइलों को पढ़ती है। cURL वैकल्पिक आवश्यकताओं Bash, cURL 7.76+ और jq.
python3 -m pip install requestsRealtime: अब परिणाम प्राप्त करें
POST /v1/queries/realtime रिटर्न status: done और एक परिणाम सरणी। result.json; कोई मतदान की आवश्यकता नहीं है।
realtime.py के रूप में सहेजें और python3 realtime.py चलाने के लिए।
import json
import os
from pathlib import Path
import requests
response = requests.post(
"https://data.flashdata.dev/v1/queries/realtime",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
json={"source": "google_search", "query": "battery recycling research", "params": {"num": 5}},
timeout=120, allow_redirects=False,
)
response.raise_for_status()
result = response.json()
Path("result.json").write_text(json.dumps(result, indent=2), encoding="utf-8")
print(json.dumps(result, indent=2))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' \
--data '{"source":"google_search","query":"battery recycling research","params":{"num":5}}' \
--output result.json &&
jq '{source, status, results, usage}' result.jsonAsync: नौकरी रसीद बचाओ
POST /v1/queries एक लंबित नौकरी रसीद लौटाता है, न कि खोज परिणाम। submission.json को सेव करें और नीचे की स्थिति और परिणाम अनुरोधों के साथ जारी रखें।
submit_async.py के रूप में सहेजें और python3 submit_async.py चलाने के लिए।
import json
import os
from pathlib import Path
import requests
response = requests.post(
"https://data.flashdata.dev/v1/queries",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
json={"source": "google_search", "query": "battery recycling research", "params": {"num": 5}},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
result = response.json()
Path("submission.json").write_text(json.dumps(result, indent=2), encoding="utf-8")
print(json.dumps(result, indent=2)){
"id": "job_EXAMPLE",
"source": "google_search",
"status": "pending"
}curl --fail-with-body --silent --show-error \
'https://data.flashdata.dev/v1/queries' \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{"source":"google_search","query":"battery recycling research","params":{"num":5}}' \
--output submission.json &&
jq '{id, source, status, links}' submission.json{
"id": "job_EXAMPLE",
"source": "google_search",
"status": "pending"
}एक Async नौकरी की जाँच करें
submission.json में ID का उपयोग करके job.status को पढ़ें। लंबित या प्रसंस्करण के लिए, फिर से जांच करने से पहले Retry-After देरी की प्रतीक्षा करें; Python इसे प्रिंट करता है और cURL इसे status-headers.txt में बचाता है। अगर कोई संकेत वापस नहीं आया है तो बैकऑफ का प्रयोग करें। एक सफल स्टेटस अनुरोध का मतलब यह नहीं है कि नौकरी पूरी हो गई है।
| job.status | अगली कार्रवाई |
|---|---|
| pending / processing | फिर से उसी नौकरी की जाँच करें ID फिर से। |
| completed | बचाया परिणाम पुनर्प्राप्त करें। |
| failed | पढ़िए job.error. नए काम को जमा करने से पहले कारण को ठीक करें। |
job_status.py के रूप में सहेजें और python3 job_status.py चलाने के लिए।
import json
import os
from pathlib import Path
import requests
job_id = json.loads(Path("submission.json").read_text(encoding="utf-8"))["id"]
response = requests.get(
f"https://api.flashdata.dev/v2/jobs/{job_id}",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
Path("job.json").write_text(json.dumps(response.json(), indent=2), encoding="utf-8")
print(json.dumps(response.json()["job"], indent=2))
print("Retry-After:", response.headers.get("Retry-After", "not provided"))JOB_ID=$(jq -er '.id' submission.json)
curl --fail-with-body --silent --show-error \
"https://api.flashdata.dev/v2/jobs/$JOB_ID" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--dump-header status-headers.txt --output job.json &&
jq '.job | {id, source, status, error}' job.jsonपूरा परिणाम प्राप्त करें
इसे job.status के पूरा होने के बाद चलाएं। डिफ़ॉल्ट परिणाम प्रतिक्रिया 302 है: स्थान एक हस्ताक्षरित भंडारण URL को इंगित करता है। नीचे दिए गए दो अनुरोधों में FlashData पर अपनी API कुंजी रखी जाती है और मूल JSON को result.json में सहेज लिया जाता है। YouTube Download के लिए, यह JSON आपके भंडारण के लिए वितरित मीडिया का वर्णन करता है; यह वीडियो या ऑडियो फ़ाइल नहीं है।
job_result.py के रूप में सहेजें और python3 job_result.py चलाने के लिए।
import json
import os
from pathlib import Path
import requests
receipt = json.loads(Path("submission.json").read_text(encoding="utf-8"))
job_id = receipt["id"]
response = requests.get(
f"https://api.flashdata.dev/v2/jobs/{job_id}/results",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
if response.status_code != 302:
raise RuntimeError(f"Expected a result redirect, got {response.status_code}")
url = response.headers["Location"]
if not url.startswith("https://"):
raise ValueError("Expected an HTTPS storage URL")
# A separate request: no FlashData key is sent to storage.
result = requests.get(url, timeout=120)
result.raise_for_status()
data = result.json() # Requests automatically decodes Content-Encoding: gzip.
Path("result.json").write_text(json.dumps(data, indent=2), encoding="utf-8")
print(json.dumps(data, indent=2))JOB_ID=$(jq -er '.id' submission.json)
RESULT_URL=$(curl --fail-with-body --silent --show-error \
"https://api.flashdata.dev/v2/jobs/$JOB_ID/results" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--output /dev/null --write-out '%{redirect_url}') &&
curl --fail-with-body --silent --show-error --compressed --proto '=https' \
"${RESULT_URL:?Expected a signed result URL}" --output result.json &&
jq '{source, status, results, usage}' result.jsonदेरी और विफलताओं को संभालना
| स्थिति | क्या करें |
|---|---|
| प्रस्तुतीकरण समयबद्ध | एक POST को पहले से ही स्वीकार किया जा सकता है। अपनी सहेजी गई रसीद और खाता इतिहास की जांच करने से पहले, बार-बार POSTs नई बिलेबल नौकरियों का निर्माण कर सकते हैं। |
| 409 · result_not_ready | मतदान की स्थिति रखें। किसी अन्य नौकरी का निर्माण न करें। |
| 422 · result_not_ready | नौकरी विफल हो गई। Retry से पहले job.error पढ़ें। |
| 429 | ऑनर Retry-After या retry_after; लंबित क्षमता पूर्ण होने पर जमा करने की दर को कम करें। |
| 410 · result_expired | स्टोर किए गए परिणाम पूरा होने के बाद 24 घंटे समाप्त हो जाते हैं। अपनी सहेजी गई प्रतिलिपि का प्रयोग करें। |