مرجع API

إنشاء استجابة (OpenAI Responses API)

POST/v1/responses

واجهة Responses للنص واستدعاء الأدوات؛ تعتمد الحقول الاختيارية وأنواع الأدوات على النموذج. يعيد stream=true أحداث SSE ذات أنواع؛ لا يضمن previous_response_id التخزين الدائم أو الاستعادة.

المصادقة والصلاحيات

استخدم مفتاح GloopAPI الحالي. تعتمد النماذج والإمكانات والصلاحيات المتاحة على دليله ووثائق نقطة النهاية.

Authorization: Bearer $GLOOP_API_KEY

آليات المصادقة: BearerAuth

الطلب

جسم الطلب · application/json

النوع
object
الحقول المطلوبة
modelinput

جسم الطلب مطلوب

  • modelstringمطلوب
  • inputunionمطلوب

    محتوى الإدخال، كسلسلة نصية أو مصفوفة رسائل

    فرع oneOf رقم 1

    النوع: string

    فرع oneOf رقم 2

    النوع: array

    • []objectاختياري
  • instructionsstringاختياري
  • max_output_tokensintegerاختياري
  • temperaturenumberاختياري

    درجة حرارة أخذ العينات. يعتمد الدعم والحدود المحددان على النموذج المختارين؛ ولا تُضمن قيم افتراضية موحدة.

  • top_pnumberاختياري

    معامل أخذ العينات النووي. يعتمد الدعم والحدود المحددان على النموذج المختارين؛ ولا تُضمن قيم افتراضية موحدة.

  • streambooleanاختياري
  • toolsarrayاختياري
    الحقول الفرعية لـ tools (1)
    • []objectاختياري
  • tool_choiceunionاختياري
    فرع oneOf رقم 1

    النوع: string

    فرع oneOf رقم 2

    النوع: object

  • reasoningobjectاختياري
    الحقول الفرعية لـ reasoning (2)
    • effortstringاختياري
      القيم المعدودة
      ["low","medium","high"]
    • summarystringاختياري
  • previous_response_idstringاختياري
  • truncationstringاختياري
    القيم المعدودة
    ["auto","disabled"]
  • parallel_tool_callsbooleanاختياري

    يعتمد السماح باستدعاءات الأدوات المتوازية على النموذج المختار. يقبل Chat قيمة منطقية، وتقبل Responses قيم JSON للبروتوكول المتوافق.

  • storebooleanاختياري

    يعتمد السماح بحفظ الطلبات والاستجابات على النموذج المختار وإمكانات الخدمة المدعومة. لا يوفر هذا واجهة عامة لتخزين المحادثات.

  • prompt_cache_keystringاختياري

    معرّف ربط ذاكرة التوجيهات لدى الخدمة، حسب النموذج ودون ضمان الدعم أو الإصابة. يقبل Chat سلسلة نصية، وتقبل Responses قيمة JSON للبروتوكول.

  • prompt_cache_retentionunknownاختياري

    قيمة JSON لضبط احتفاظ ذاكرة توجيهات الخدمة، حسب النموذج. لا تمنح المنصة تعدادًا أو افتراضيًا موحدًا أو ضمان احتفاظ.

  • service_tierstringاختياري

    مستوى الخدمة المطلوب، وقد يؤثر في التكلفة. يُتجاهل افتراضيًا ولا يسري إلا عند دعمه. تعتمد القيم المقبولة على النموذج المختار.

  • textobjectاختياري

    إعداد إخراج النص، بما فيه format للإخراج المنظم؛ يعتمد الدعم والقيود على النموذج المحدد.

    الحقول الفرعية لـ text (1)
    • formatobjectاختياري

      إعداد تنسيق النص والإخراج المنظم حسب النموذج.

      الحقول الفرعية لـ format (4)
      • typestringاختياري

        معرّفات تنسيقات المخرجات التي يدعمها النموذج المختار.

      • namestringاختياري

        اسم المخرجات المنظمة.

      • schemaobjectاختياري

        JSON Schema للإخراج المنظم؛ يجب أن يطابق متطلبات النموذج.

        خصائص إضافية
        true
      • strictbooleanاختياري

        طلب إخراج منظم صارم حسب دعم النموذج.

  • context_managementunknownاختياري

    إعداد إدارة السياق حسب النموذج؛ لا يضمن التلخيص التلقائي أو الذاكرة الدائمة.

  • stream_optionsobjectاختياري

    معلمات بث Responses مع stream=true؛ لا تسري إلا الحقول المدعومة.

    الحقول الفرعية لـ stream_options (2)
    • include_usagebooleanاختياري

      طلب بيانات الاستخدام في البث؛ يعتمد توفرها على النموذج.

    • include_obfuscationbooleanاختياري

      التحكم في تعمية بث Responses؛ يُتجاهل افتراضياً ولا يسري إلا عند دعمه.

الاستجابات والأخطاء

HTTP 200

تم إنشاء الاستجابة بنجاح

application/json

النوع
object
خصائص إضافية
false
  • idstringاختياري
  • objectstringاختياري
  • created_atintegerاختياري
  • statusstringاختياري
    القيم المعدودة
    ["completed","failed","in_progress","incomplete"]
  • modelstringاختياري
  • outputarrayاختياري
    الحقول الفرعية لـ output (1)
    • []objectاختياري
      خصائص إضافية
      false
      الحقول الفرعية لـ [] (8)
      • typestringاختياري
      • idstringاختياري
      • statusstringاختياري
      • rolestringاختياري
      • contentarrayاختياري
        الحقول الفرعية لـ content (1)
        • []objectاختياري
          خصائص إضافية
          false
          الحقول الفرعية لـ [] (3)
          • typestringاختياري
            القيم المعدودة
            ["output_text","refusal"]
          • textstringاختياري
          • annotationsarrayاختياري
            الحقول الفرعية لـ annotations (1)
            • []objectاختياري
      • call_idstringاختياري
      • namestringاختياري
      • argumentsstringاختياري
  • usageobjectاختياري
    الحقول الفرعية لـ usage (5)

text/event-stream

النوع
string
الوصف
بث أحداث SSE؛ الأحداث والاستخدام وعلامات النهاية حسب الواجهة الحالية، وقد تظهر الأخطاء داخل البث.
{
  "type": "string",
  "description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}

HTTP 401

Key مفقود أو غير صالح أو منتهي أو ملغى.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 403

صلاحيات IP أو الحساب أو النموذج أو الأداة غير كافية.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 429

حد معدل الطلبات/قائمة الانتظار.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 500

فشل داخلي في المصادقة أو تخزين البيانات.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)