مرجع API
إنشاء استجابة (OpenAI Responses API)
/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
instructionsstringاختياريmax_output_tokensintegerاختياريtemperaturenumberاختياريدرجة حرارة أخذ العينات. يعتمد الدعم والحدود المحددان على النموذج المختارين؛ ولا تُضمن قيم افتراضية موحدة.
top_pnumberاختياريمعامل أخذ العينات النووي. يعتمد الدعم والحدود المحددان على النموذج المختارين؛ ولا تُضمن قيم افتراضية موحدة.
streambooleanاختياريtoolsarrayاختياريالحقول الفرعية لـ tools (1)
[]objectاختياري
tool_choiceunionاختياريفرع oneOf رقم 1
النوع: string
فرع oneOf رقم 2
النوع: object
reasoningobjectاختياري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اختياريإعداد تنسيق النص والإخراج المنظم حسب النموذج.
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)
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اختياري
text/event-stream
- النوع
- string
- الوصف
- بث أحداث SSE؛ الأحداث والاستخدام وعلامات النهاية حسب الواجهة الحالية، وقد تظهر الأخطاء داخل البث.
{
"type": "string",
"description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}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
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 500
فشل داخلي في المصادقة أو تخزين البيانات.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري