مرجع API

إنشاء إكمال محادثة

POST/v1/chat/completions

مدخل نص/أدوات متوافق مع OpenAI Chat Completions؛ يتطلب image_url نموذجًا يدعم الصور. المخرجات نص/أدوات، والإمكانات والحقول الاختيارية والأسعار حسب النموذج. يعيد stream=true بث SSE قد يتضمن الاستخدام النهائي وينتهي بـ data: [DONE].

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

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

Authorization: Bearer $GLOOP_API_KEY

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

الطلب

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

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

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

  • modelstringمطلوب

    معرّف النموذج

  • messagesarrayمطلوب

    قائمة رسائل المحادثة

    الحقول الفرعية لـ messages (1)
    • []objectاختياري
      الحقول الفرعية لـ [] (6)
      • rolestringمطلوب

        دور الرسالة

        القيم المعدودة
        ["system","user","assistant","tool","developer"]
      • contentunionمطلوب

        محتوى الرسالة

        فرع oneOf رقم 1

        النوع: string

        فرع oneOf رقم 2

        النوع: array

        • []objectاختياري
          الحقول الفرعية لـ [] (6)
          • typestringاختياري
            القيم المعدودة
            ["text","image_url","input_audio","file","video_url"]
          • textstringاختياري
          • image_urlunionاختياري

            يدعم مدخلات منقولة كسلسلة URL/Base64 أو كائن {url, detail}. متاح فقط للنماذج التي تدعم إدخال الصور؛ وليس ضمانًا بأن جميع النماذج تدعم الرؤية.

            فرع oneOf رقم 1

            رابط صورة أو رابط بيانات Base64.

            النوع: string

            فرع oneOf رقم 2

            يجب أن تتضمن مدخلات الكائن url على الأقل. يحوّل Message.ParseContent قيمة detail المحذوفة إلى high؛ ويعتمد الدعم على نموذج الرؤية المختار.

            النوع: object

            المطلوب في هذا الفرع: url

            • urlstringمطلوب

              رابط صورة أو base64

            • detailstringاختياري
              القيم المعدودة
              ["low","high","auto"]
          • input_audioobjectاختياري
            الحقول الفرعية لـ input_audio (2)
            • datastringاختياري

              بيانات صوتية مرمّزة بـ Base64

            • formatstringاختياري
              القيم المعدودة
              ["wav","mp3"]
          • fileobjectاختياري
            الحقول الفرعية لـ file (3)
          • video_urlstringاختياري

            المدخل الفعلي المنقول الذي يقرؤه Message.ParseContent هو سلسلة رابط فيديو، وهو متاح فقط للنماذج التي تدعم إدخال الفيديو. لا يدخل كائن {url: ...} في نتائج المحتوى/القياس لهذا المحلّل، ولا يُنشر بوصفه عقدًا صالحًا للاستخدام.

      • namestringاختياري

        اسم المرسل

      • tool_callsarrayاختياري
        الحقول الفرعية لـ tool_calls (1)
        • []objectاختياري
          الحقول الفرعية لـ [] (3)
          • idstringاختياري
          • typestringاختياري
          • functionobjectاختياري
            الحقول الفرعية لـ function (2)
      • tool_call_idstringاختياري

        معرّف استدعاء الأداة (للرسائل ذات دور tool)

      • reasoning_contentstringاختياري

        محتوى الاستدلال

  • temperaturenumberاختياري

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

  • top_pnumberاختياري

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

  • nintegerاختياري

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

  • streambooleanاختياري

    هل تُبث الاستجابة تدريجيًا

    القيمة الافتراضية
    false
  • stream_optionsobjectاختياري

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

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

    تسلسلات التوقف

    فرع oneOf رقم 1

    النوع: string

    فرع oneOf رقم 2

    النوع: array

    • []stringاختياري
  • max_tokensintegerاختياري

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

  • max_completion_tokensintegerاختياري

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

  • presence_penaltynumberاختياري

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

  • frequency_penaltynumberاختياري

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

  • logit_biasobjectاختياري
    الحقول الفرعية لـ logit_bias (1)
    • [key]numberاختياري
  • userstringاختياري
  • toolsarrayاختياري
    الحقول الفرعية لـ tools (1)
    • []objectاختياري
      الحقول الفرعية لـ [] (2)
      • typestringاختياري
      • functionobjectاختياري
        الحقول الفرعية لـ function (3)
        • namestringاختياري
        • descriptionstringاختياري
        • parametersobjectاختياري

          تعريف المعاملات بتنسيق JSON Schema

  • tool_choiceunionاختياري
    فرع oneOf رقم 1

    النوع: string

    القيم المعدودة: ["none","auto","required"]

    فرع oneOf رقم 2

    النوع: object

    • typestringاختياري
    • functionobjectاختياري
      الحقول الفرعية لـ function (1)
      • namestringاختياري
  • response_formatobjectاختياري
    الحقول الفرعية لـ response_format (2)
    • typestringاختياري
      القيم المعدودة
      ["text","json_object","json_schema"]
    • json_schemaobjectاختياري

      تعريف JSON Schema

  • seedintegerاختياري

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

  • reasoning_effortstringاختياري

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

  • modalitiesarrayاختياري
    الحقول الفرعية لـ modalities (1)
    • []stringاختياري
      القيم المعدودة
      ["text","audio"]
  • audioobjectاختياري
    الحقول الفرعية لـ audio (2)
  • parallel_tool_callsbooleanاختياري

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

  • storebooleanاختياري

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

  • prompt_cache_keystringاختياري

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

  • prompt_cache_retentionunknownاختياري

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

  • service_tierunknownاختياري

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

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

HTTP 200

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

application/json

النوع
object
خصائص إضافية
false
  • idstringاختياري
  • objectstringاختياري
  • createdintegerاختياري
  • modelstringاختياري
  • choicesarrayاختياري
    الحقول الفرعية لـ choices (1)
    • []objectاختياري
      خصائص إضافية
      false
      الحقول الفرعية لـ [] (3)
      • indexintegerاختياري
      • messageobjectاختياري
        خصائص إضافية
        false
        الحقول الفرعية لـ message (5)
        • rolestringمطلوب
          القيم المعدودة
          ["assistant"]
        • contentstringاختيارييسمح بـ null

          المحتوى النصي للاستجابة.

        • tool_callsarrayاختياري
          الحقول الفرعية لـ tool_calls (1)
          • []objectاختياري
            الحقول الفرعية لـ [] (3)
            • idstringاختياري
            • typestringاختياري
            • functionobjectاختياري
              الحقول الفرعية لـ function (2)
        • reasoning_contentstringاختيارييسمح بـ null
        • refusalstringاختيارييسمح بـ null
      • finish_reasonstringاختياري
        القيم المعدودة
        ["stop","length","tool_calls","content_filter"]
  • usageobjectاختياري
    الحقول الفرعية لـ usage (5)
  • system_fingerprintstringاختياري

text/event-stream

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

HTTP 400

معاملات طلب غير صالحة

application/json

النوع
object
  • errorobjectاختياري
    الحقول الفرعية لـ error (4)
    • messagestringاختياري

      رسالة الخطأ

    • typestringاختياري

      نوع الخطأ

    • paramstringاختيارييسمح بـ null

      المعاملات ذات الصلة

    • codestringاختيارييسمح بـ null

      رمز الخطأ

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
  • errorobjectاختياري
    الحقول الفرعية لـ error (4)
    • messagestringاختياري

      رسالة الخطأ

    • typestringاختياري

      نوع الخطأ

    • paramstringاختيارييسمح بـ null

      المعاملات ذات الصلة

    • codestringاختيارييسمح بـ null

      رمز الخطأ

HTTP 500

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

application/json

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