सीधे सामग्री पर जाएँ
HI
API कुंजी प्राप्त करें
दस्तावेज़ देखें

API संदर्भ

YouTube Suggestions API

API कुंजी लें

भाषा और क्षेत्र नियंत्रण के साथ, एक कीवर्ड या वाक्यांश के लिए YouTube स्वत: पूर्ण सुझाव प्राप्त करें।

अनुरोध बनाएँ

कैप्शन या सुझाव भाषा कोड, जैसे कि एन।

दो-अक्षर देश कोड, जैसे कि अमेरिका।

POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_suggestions",
    "query": "python",
    "params": {
        "language": "en",
        "region": "us",
    },
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
परिणाम HTTP उत्तरदायित्वX-API-Key प्रमाणीकरण

पैरामीटर

भेजें source और query शीर्ष स्तर पर। स्रोत विकल्प params. वैकल्पिक क्षेत्रों को छोड़ा जा सकता है।

अनुरोध का मुख्य भाग

sourcestring / ज़रूरी
youtube_suggestions को सेट करें।
querystring / ज़रूरी
Prefix खोजना
1 to 2,000 वर्णडिफ़ॉल्ट: सेट नहीं
paramsobject / वैकल्पिक
इस अनुरोध के लिए Settings
डिफ़ॉल्ट: {}
callback_urlstring · nullable / वैकल्पिक
केवल Async और बैच। सार्वजनिक HTTPS पूरा होने URL बंदरगाह 443 पर, 2,048 वर्ण तक। कोई उपयोगकर्ता क्रेडेंशियल या URL खंड नहीं। Omit, उपयोग null या कोई अधिसूचना के लिए एक खाली स्ट्रिंग। एक बैच में, इसे प्रत्येक क्वेरी पर सेट करें, बाहर के पैराम।
डिफ़ॉल्ट: सेट नहीं

भाषा और क्षेत्र

params.languagestring / वैकल्पिक
भाषा कोड।
1 to 35 वर्णडिफ़ॉल्ट: "en"
स्वीकृत प्रारूप^[A-Za-z0-9-]+$
params.regionstring / वैकल्पिक
दो-अक्षर देश कोड, जैसे कि अमेरिका, जीबी या डीई।
Exactly 2 वर्णडिफ़ॉल्ट: "US"
स्वीकृत प्रारूप^[A-Za-z]{2}$

जवाब

Realtime रिटर्न status: done. पर स्रोत उत्पादन पढ़ें results[0]; usage.credits चार्ज रिकॉर्ड करता है।

परिणाम [0] सुझाए गए खोज वाक्यांशों की एक सरणी है, वीडियो ऑब्जेक्ट नहीं। यह खाली हो सकता है; इस प्रतिक्रिया में कोई वीडियो IDs या सगाई की गिनती नहीं है।

परिणाम पढ़ें

सफल JSON प्रतिक्रिया को response.json के रूप में सहेजें। इसे read-response.py के रूप में सहेजें और python read-response.py चलाएं। यह केवल Python के मानक पुस्तकालय का उपयोग करता है और कोई नया अनुरोध नहीं करता है।

read-response.py
import json
from pathlib import Path

response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
    raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
    print("[]")
    raise SystemExit(0)
result = response["results"][0]

output = result  # An array of phrases, including an empty array.
print(json.dumps(output, ensure_ascii=False, indent=2))

क्वेरी के रूप में खोज उपसर्ग को भेजें। भाषा और दो-पत्रिका क्षेत्र परम में हैं; डिफ़ॉल्ट रूप से एन और यूएस हैं। वे स्वतः पूर्ण संदर्भ को प्रभावित करते हैं, वीडियो मेटाडाटा नहीं।

discover वीडियो के लिए एक सुझाए गए वाक्यांश के साथ खोज या विस्तारित खोज का उपयोग करें। सुझाव max_results या खोज फ़िल्टर का समर्थन नहीं करते हैं।

सभी प्रतिक्रिया क्षेत्र
फील्डविवरण
sourcestringअनुरोधित API स्रोत।
statusstringजब रियलटाइम अनुरोध सफल होता है तो किया जाता है।
created_atstringISO 8601 प्रारूप में प्रतिक्रिया निर्माण समय।
usage.creditsnumberआपकी योजना के आधार पर अनुरोध के लिए शुल्क लिया गया क्रेडिट।
results[0]array<string>स्वतः पूर्ण सुझाव। प्रत्येक सरणी प्रविष्टि एक सुझाव दिया खोज वाक्यांश है।

ऊपर दिए गए फ़ील्ड डिफ़ॉल्ट JSON प्रतिक्रिया का वर्णन करते हैं। JSON, सादे पाठ और Markdown प्रारूप.

Async एक नौकरी रसीद लौटाता है; बैच प्रति एक रिटर्न देता है क्वेरी. प्रत्येक नौकरी की स्थिति की जांच करें और लौटाए गए लिंक का उपयोग करके अपने परिणाम पुनर्प्राप्त करें।

Async & बैच जीवनचक्र

सबमिशन एक रसीद लौटाता है, परिणाम नहीं देता है। Async एक नौकरी बनाता है; बैच में एक अलग काम देता है queries[] प्रत्येक स्वीकृत क्वेरी के लिए। प्रत्येक नौकरी को स्वतंत्र रूप से ट्रैक और पुनर्प्राप्त करें।

प्रस्तुत करना data.flashdata.dev; नौकरी की स्थिति और परिणाम पढ़ने से api.flashdata.dev उसी X-API-Key के साथ। लिंक्ड API मूलभूत उदाहरण Python और cURL का उपयोग करते हैं।

  1. 1. नौकरी बचाओ IDs

    इस स्रोत के अनुरोध फ़ील्ड को Async पर स्विच करते समय रखें। Batch के लिए, प्रत्येक अनुरोध को एक JSON ऑब्जेक्ट की क्वेरी सरणी के अंदर रखें। प्रत्येक वापसी कार्य ID बचाओ।

    Async अनुरोध और रसीद · Batch अनुरोध शरीर

  2. 2. स्थिति की जाँच करें

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing: देरी और सम्मान के साथ मतदान Retry-After जब उपस्थित हो। completed: परिणाम प्राप्त करें। failed: निरीक्षण job.error.

    job.status पढ़ें, प्रस्तुतीकरण रसीद की स्थिति नहीं।

    चेक स्थिति · Python और cURL

    नौकरी की स्थिति API संदर्भ
  3. 3. Fetch परिणाम

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    पूरा होने के बाद, परिणाम को प्रमाणित करें, फिर अपने API कुंजी के बिना 302 संग्रहण URL प्राप्त करें। JSON को 24 घंटे पूरा होने के भीतर सहेजें।

    Fetch परिणाम · Python और cURL · जवाब के फ़ॉर्मैट

    परिणाम डाउनलोड API

मतदान और मौजूदा परिणाम प्राप्त करने के लिए क्वेरी क्रेडिट का उपभोग नहीं करते हैं। एक मतदान टाइमआउट नौकरी को रद्द नहीं करता है: डुप्लिकेट बिलेबल वर्क जमा करने के बजाय अपने ID को रखें। त्रुटि कोड और पुनर्प्राप्ति व्यवहार.

पूरा होने पर वेबहुक

क्वेरी के अनुसार सदस्यता लें

सेट callback_url एक async अनुरोध के शीर्ष स्तर पर, या प्रत्येक क्वेरी के अंदर एक बैच में, बाहर params. कोई अलग वेबहुक पंजीकरण अनुरोध की आवश्यकता नहीं है। Realtime अनुरोध कॉलबैक नहीं भेजता है।

पोर्ट 443 पर एक सार्वजनिक HTTPS URL का उपयोग करें। FlashData POSTs प्रत्येक नौकरी के लिए एक अधिसूचना तक पहुँचने के लिए completed या failed; इस घटना में लिंक शामिल हैं, न कि परिणाम स्वयं।

स्वीकार करना और सत्यापित करना

वापसी 2xx इस घटना को स्वीकार करने के बाद। Deduplicate by Deduplicate delivery_id, भी भेजा गया X-Delivery-Id. पुनर्निर्देशन का पालन नहीं किया जाता।

विफल प्रसव एक्सोनेंशियल बैकऑफ़ के साथ वापसी, अप करने के लिए 8 कुल प्रयास करता है और अधिक पूरा होने के बाद 24 घंटे. मतदान को गिरने के रूप में रखें।

कॉलबैक को इस्तीफा नहीं दिया जाता है। नौकरी की पुष्टि करें ID, स्रोत और टर्मिनल स्थिति के माध्यम से प्रमाणित स्थिति समापन बिंदु अधिसूचना को संसाधित करने से पहले। वितरण ID, deduplication के लिए है, प्रामाणिकता का प्रमाण नहीं है।

उदाहरण वेबहुक घटना और फ़ील्ड
इलस्ट्रेटिव पूर्णता अधिसूचना
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_suggestions",
  "status": "completed",
  "links": [
    {
      "rel": "self",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001",
      "method": "GET"
    },
    {
      "rel": "results",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
      "method": "GET"
    }
  ]
}
फील्डविवरण
delivery_idstringस्थिर वितरण पहचानकर्ता। इस मूल्य का उपयोग करके Deduplicate नोटिफिकेशन; इसे X-Delivery-Id हेडर में भी भेजा जाता है।
idstringनौकरी ID
sourcestringअनुरोधित डेटा स्रोत।
statusstringपूरा या विफल हो गया।
linksarrayस्थिति और परिणाम लिंक। अधिसूचनाओं में परिणाम सामग्री या एक API कुंजी शामिल नहीं है।
links[].relstringस्वयं या परिणाम।
links[].hrefstringपूर्ण प्रबंधन API URL; अपने API कुंजी के साथ प्रमाणित।
links[].methodstringGET.

पूर्ण वेबहुक अनुबंध और URL प्रतिबंध

त्रुटि

किसी भी प्रकार की चीज़ें एक सफल खाली प्रतिक्रिया है। यदि आवश्यक हो तो उपसर्ग, भाषा या क्षेत्र को समायोजित करें; असफल नौकरी के रूप में एक खाली सरणी का इलाज न करें।

प्रमाणीकरण, संतुलन, अनुरोध प्रारूप और दर सीमा विफलताओं के लिए, साझा त्रुटि संदर्भ का उपयोग करें। अभी भी एक नौकरी का निर्माण हो सकता है; पुनः प्रयास करने से पहले मौजूदा काम की जांच करें।

त्रुटियाँ और स्टेटस कोड · कब्ज़ा · दर सीमा

चरण-दर-चरण गाइड: एक खोज में सुझाव बारी

कीमतें

योजनाउपयोग की दरेंप्रति 1,000 मानक अनुरोधसदस्यताप्रति बिलिंग अवधि में क्रेडिट शामिल
इस्तेमाल के अनुसार भुगतान$0.50कोई मासिक शुल्क नहींज़रूरत पर रिचार्ज करें
Micro$0.40$49.00 / महीना1,000 क्रेडिट्स ($50.00 of API उपयोग) में शामिल
Starter$0.35$199.00 / महीना4,000 क्रेडिट्स ($200.00 of API उपयोग) में शामिल
Pro$0.30$499.00 / महीना10,000 क्रेडिट्स ($500.00 of API उपयोग) में शामिल
Scale$0.25$999.00 / महीना20,000 क्रेडिट्स ($1,000.00 of API उपयोग) में शामिल
Business$0.20$1,999.00 / महीना40,000 क्रेडिट्स ($2,000.00 of API उपयोग) में शामिल

एक खाता प्लान। तीनों उत्पादों में साझा क्रेडिट। शामिल क्रेडिट से चुकाए गए उपयोग पर दोबारा शुल्क नहीं लगता।

वर्तमान मूल्य और योजना सीमा