مرجع API
إنشاء إكمال محادثة
/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
input_audioobjectاختياريfileobjectاختياريvideo_urlstringاختياريالمدخل الفعلي المنقول الذي يقرؤه Message.ParseContent هو سلسلة رابط فيديو، وهو متاح فقط للنماذج التي تدعم إدخال الفيديو. لا يدخل كائن {url: ...} في نتائج المحتوى/القياس لهذا المحلّل، ولا يُنشر بوصفه عقدًا صالحًا للاستخدام.
namestringاختيارياسم المرسل
tool_callsarrayاختياريtool_call_idstringاختياريمعرّف استدعاء الأداة (للرسائل ذات دور tool)
reasoning_contentstringاختياريمحتوى الاستدلال
temperaturenumberاختياريدرجة حرارة أخذ العينات. يعتمد الدعم والحدود المحددان على النموذج المختارين؛ ولا تُضمن قيم افتراضية موحدة.
top_pnumberاختياريمعامل أخذ العينات النووي. يعتمد الدعم والحدود المحددان على النموذج المختارين؛ ولا تُضمن قيم افتراضية موحدة.
nintegerاختياريعدد العناصر المطلوب توليدها. يعتمد الدعم والحدود المحددان على النموذج المختارين؛ ولا تُضمن قيم افتراضية موحدة.
streambooleanاختياريهل تُبث الاستجابة تدريجيًا
- القيمة الافتراضية
false
stream_optionsobjectاختياريخيارات الاستخدام في بث Chat؛ يعتمد الدعم وإرجاع بيانات الاستخدام على النموذج المختار.
الحقول الفرعية لـ stream_options (1)
include_usagebooleanاختياري
stopunionاختياريتسلسلات التوقف
فرع oneOf رقم 1
النوع: 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"]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اختياري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"]
المحتوى النصي للاستجابة.
tool_callsarrayاختياري
finish_reasonstringاختياري- القيم المعدودة
["stop","length","tool_calls","content_filter"]
usageobjectاختياريالحقول الفرعية لـ usage (5)
prompt_tokensintegerاختياريعدد رموز التوجيه
completion_tokensintegerاختياريعدد رموز الإكمال
total_tokensintegerاختياريإجمالي عدد الرموز
prompt_tokens_detailsobjectاختياريالحقول الفرعية لـ prompt_tokens_details (4)
cached_tokensintegerاختياريtext_tokensintegerاختياريaudio_tokensintegerاختياريimage_tokensintegerاختياري
completion_tokens_detailsobjectاختياريالحقول الفرعية لـ completion_tokens_details (3)
text_tokensintegerاختياريaudio_tokensintegerاختياريreasoning_tokensintegerاختياري
system_fingerprintstringاختياري
text/event-stream
- النوع
- string
- الوصف
- بث أحداث SSE؛ الأحداث والاستخدام وعلامات النهاية حسب الواجهة الحالية، وقد تظهر الأخطاء داخل البث.
{
"type": "string",
"description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}HTTP 400
معاملات طلب غير صالحة
application/json
- النوع
- object
errorobjectاختياري
HTTP 401
Key مفقود أو غير صالح أو منتهي أو ملغى.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 403
صلاحيات IP أو الحساب أو النموذج أو الأداة غير كافية.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 429
حد معدل الطلبات
application/json
- النوع
- object
errorobjectاختياري
HTTP 500
فشل داخلي في المصادقة أو تخزين البيانات.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري