API 参考
创建响应 (OpenAI Responses API)
/v1/responsesResponses 文本与工具调用接口;可选字段和工具类型取决于模型支持。stream=true 返回带 type 的 SSE 事件;previous_response_id 不保证持久保存或可恢复。
鉴权与权限
使用当前 GloopAPI Key。模型、功能与权限以当前 Key 的目录及接口说明为准。
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 指定结构化输出;具体支持与限制取决于所选模型。
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选填usageobject选填usage 子字段(5)
prompt_tokensinteger选填提示词 Token 数
completion_tokensinteger选填补全 Token 数
total_tokensinteger选填总 Token 数
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选填