تخطَّ إلى المحتوى
AR
الحصول على مفتاح API
تصفح الوثائق

مرجع API

تنسيقات الاستجابة

الاختراع مهيأ JSON لطلبك أو Markdown محتواه لوكيل الـ(آي آي) التحكم في الرد مع اثنين من رؤساء.

في هذه الصفحة

اختر استمارة

الافتراضي هو JSON بحقول النتائج الأصلية. يختار Accept صيغة JSON أو النص العادي؛ ويحوّل X-Respond-With: markdown محتوى النتيجة إلى Markdown. يبقى جسم طلبك بصيغة JSON.

استجابةAcceptX-Respond-Withالاستخدام
JSONapplication/jsonOmitحقول العزل في الرمز
JSON + Markdownapplication/jsonmarkdownسياق عمل مع البيانات الوصفية المنظمة
نص قُضيtext/plainOmitقراءة الحقول الأصلية في محطة
النص + Markdowntext/plainmarkdownقراءة البيانات الفوقية و Markdown معا

أمثلة للطلبات والاستجابة

تعرض علامات التبويب بحث Google نفسه بكل صيغة. استخدم Bash وcURL 7.76+ مع ضبط FLASHDATA_API_KEY على مفتاح يسمح بـ google_search. يرسل كل تشغيل للأمر بحثًا واحدًا مدفوعًا.

خطأ. تطهير صفيفة النتائج؛ وتعتمد المجالات داخلها على المصدر.

الطلب: cURL/ Bash
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' \
  --header 'Accept: application/json' \
  --data '{"source":"google_search","query":"vector databases"}'
الاستجابة على سبيل المثال: قيم توضيحية
{
  "source": "google_search",
  "status": "done",
  "results": [
    {
      "organic": [
        {
          "title": "Example page",
          "link": "https://example.com/article",
          "snippet": "A short source snippet."
        }
      ]
    }
  ],
  "usage": {
    "credits": 0.01
  },
  "created_at": "2026-10-22T12:00:00.000Z"
}

نقاط النهاية المدعومة

وتنطبق نفس القواعد على مصادر الاستفسار من Google Search و YouTube. بالنسبة لـ YouTube Download، فإنها تشكل سجل التوصيل، وليس الفيديو أو اللوحات الصوتية. وتستخدم نماذجها الخاصة في حساب مؤشرات الأداء، وبيانات Bulk، وأجزاء من NDJSON، والردود على المكالمات، وردود MCP.

نقطة النهايةJSON/ plain textمحتوى Markdown
POST /v1/queries/realtimeالدعمالدعم
GET /v2/jobs/{id}/resultsالدعمالدعم
POST /v1/queriesإيصال المعلومات- اختياره عند قراءة النتائج
POST /v1/queries/batchإيصال المعلومات- اختياره عند قراءة النتائج
GET /v2/jobs/{id}مركز العمللا يوجد هناك أي نتيجة هنا

الصيغة النهائية لنتيجة العمل

ضعوا الرعاة عند قراءة النتيجة، حتى لو وضعتموهم في المقدمة. المجموعة JOB_ID إلى عمل مكتمل يمكنك الوصول إليه ويقرأ هذا الرقم " GET " النتائج القائمة دون تقديم استفسار آخر.

الشكل المطلوباستجابة النتيجة
Original JSON302 مع رابط تخزين موقّع في Location. اجلب ذلك الرابط منفصلًا دون X-API-Key. قد تكون النتائج المخزنة مضغوطة بـ gzip.
نص مقدم أو خيار Markdownاستجابة 200 مع النص المنسّق مباشرة في الاستجابة.
Retrieve Markdown inside JSON ; cURL / Bash
curl --fail-with-body --silent --show-error \
  "https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}/results" \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json' \
  --header 'X-Respond-With: markdown'

الأخطاء الشكلية

API الأخطاء تبقى JSON أو application/problem+jsonحتى عندما تطلب نصاً عادياً تحقق من حالة HTTP قبل أن تقطع استمارة النجاح.

الحالة/الرمزFix
400 · unsupported_representationإستعملْ X-Respond-With: علامة أسفل أَو omit the header. ولا تحظى قيم مثل " جيسون " أو النص بتأييد.
406 · not_acceptableالاستخدام Accept: application/json أو text/plain. text/markdown و application/xml غير مدعوم.

تفاصيل عن رئيس شركة Accept

احذف Accept أو أرسل */* للحصول على JSON. تستخدم الاستجابات UTF-8. تُدعم نطاقات الوسائط وأوزان q؛ ويعيد charset غير المدعوم 406 إلا إذا طابق نطاقًا مقبولًا آخر. يصف Content-Type: application/json جسم الطلب، وليس الاستجابة.

النص المفضّل، السماح JSON
Accept: text/plain; charset=utf-8, application/json;q=0.8