创建 Response
/v1/responses使用 OpenAI Responses API 创建模型响应。该端点适用于兼容 Responses API 的模型。
认证
Authorization Bearer
在 Authorization 请求头中使用 API Key 作为 Bearer Token。
请求头
Authorizationstring必填。Bearer API Key。
Content-Typestring请求体类型。
Request Body
backgroundboolean是否在后台运行响应。不支持显式 true。
context_managementobject[]上下文管理配置。
context_management.type"compaction"上下文管理项类型。
context_management.compact_thresholdnumber触发压缩的 token 阈值。
conversationstring | objectConversation ID 或 conversation 对象。不支持有状态 conversations。
conversation.idstringConversation ID。
includestring[]请求响应中包含额外输出数据。取值必须与请求的模型和已启用功能匹配。
inputstring | ResponseInputItem[]文本、图片、文件或结构化输入项。
input.typestring输入项类型。
input.role"user" | "assistant" | "system" | "developer"消息角色。
input.contentstring | ResponseInputContent[]文本或内容部件。
input.idstring引用已有输入项时的输入项 ID。
input.call_idstring工具或函数调用 ID。
input.outputstring | object[]函数、computer 或工具调用结果。
input.status"in_progress" | "completed" | "incomplete"输入项状态(如有)。
instructionsstring系统级指令。
max_output_tokensnumber生成 token 上限,包括可见输出 token 和 reasoning token。
max_tool_callsnumber单次响应中内置工具调用总数上限。适用于启用工具的请求。
metadataobject附加到响应上的最多 16 个键值对。
modelstring必填。来自 /v1/models 的模型 ID。
moderationobjectModeration 配置,取决于模型支持。
moderation.modelstring要使用的 moderation 模型。
parallel_tool_callsboolean是否允许并行工具调用,取决于模型支持。
previous_response_idstring用于多轮状态的 previous response ID。不支持该字段。
promptobject可复用 prompt 模板引用。需要已有 prompt 模板 ID。
prompt.idstringPrompt 模板 ID。
prompt.variablesobject模板变量值。
prompt.versionstringPrompt 模板版本。
prompt_cache_keystring用于提高缓存命中率的 cache key。
prompt_cache_retention"in_memory" | "24h"Prompt cache 保留策略。
reasoningobject推理配置。
reasoning.context"auto" | "current_turn" | "all_turns"后续轮次中带回哪些 reasoning 项。
reasoning.effort"none" | "minimal" | "low" | "medium" | "high" | "xhigh"推理 effort。
reasoning.generate_summary"auto" | "concise" | "detailed"已弃用的 reasoning summary 选项。
reasoning.summary"auto" | "concise" | "detailed"Reasoning summary 选项。
safety_identifierstring用于安全系统的稳定终端用户标识。
service_tier"auto" | "default" | "flex" | "scale" | "priority"处理层级。
storeboolean必须为 false 或省略。不支持显式 true。
streamboolean是否通过 Server-Sent Events 流式返回响应。
stream_optionsobject流式响应选项。适用于流式请求。
stream_options.include_obfuscationboolean是否包含 stream obfuscation 字段。
temperaturenumber采样温度,范围 0 到 2。
textobject文本响应配置。
text.formatobject响应格式配置。
text.verbosity"low" | "medium" | "high"响应详细程度。
tool_choice"none" | "auto" | "required" | object模型应如何选择工具。可用工具选择取决于已提供工具和模型能力。
tool_choice.typestring工具选择对象类型。
tool_choice.mode"auto" | "required"Allowed tools 模式。
tool_choice.toolsobject[]允许的工具定义。
tool_choice.namestring强制指定工具时的工具名。
tool_choice.server_labelstringMCP server label。
toolsobject[]模型生成响应时可以调用的工具。工具类型和嵌套字段取决于模型和账号能力。
tools.typestring工具类型。
tools.namestring工具或函数名。
tools.descriptionstring工具描述。
tools.parametersobject函数参数 JSON Schema。
tools.input_schemaobject自定义工具输入 schema。
tools.vector_store_idsstring[]File search 使用的 vector store ID。
tools.filtersobjectFile search 过滤条件。
tools.max_num_resultsnumber最大 file search 结果数。
tools.search_context_size"low" | "medium" | "high"Web search 上下文大小。
tools.user_locationobjectWeb search 使用的大致用户位置。
tools.server_labelstringMCP server label。
tools.server_urlstringMCP server URL。
tools.allowed_toolsobject | string[]允许的 MCP 工具。
tools.require_approvalstring | objectMCP 工具审批策略。
tools.containerobject | stringCode 工具的 container 配置。
tools.partial_imagesnumberImage generation 流式模式中的 partial image 数量。
top_logprobsnumber每个 token 位置返回的高概率 token 数量,范围 0 到 20。
top_pnumber核采样值。
truncation"auto" | "disabled"输入截断策略。
userstring已弃用的稳定终端用户标识。建议使用 safety_identifier 和 prompt_cache_key。
参数兼容性
部分字段会受所选模型、已启用功能以及请求是否依赖已存储响应状态影响:
background: true、conversation、previous_response_id和store: true属于有状态操作,会返回501 unsupported_feature。prompt需要已有 prompt 模板 ID。- 图片和文件输入部件需要模型支持,并提供有效的
file_id、URL 或数据。 - 工具字段取决于工具类型。
include取值和top_logprobs必须与请求的输出功能匹配。stream_options适用于流式请求。
Response
idstring响应 ID。
created_atnumberUnix 秒级时间戳。
errorobject|null响应生成失败时的错误对象。
error.codestring错误代码。
error.messagestring错误消息。
incomplete_detailsobject|nullIncomplete 响应的详细信息。
incomplete_details.reason"max_output_tokens" | "content_filter"Incomplete 原因。
instructionsstring | object[] | null该响应使用的指令。
max_output_tokensnumber|null最大输出 token 设置。
modelstring模型标识符。
object"response"对象类型。
outputobject[]输出项。
output.idstring输出项 ID。
output.typestring输出项类型。
output.status"in_progress" | "completed" | "incomplete"输出项状态。
output.rolestring消息输出项的角色。
output.contentobject[]内容部件。
output.call_idstring工具或函数调用 ID。
output.namestring工具或函数名。
output.argumentsstring函数调用参数。
output.outputstring | object[]函数或工具输出。
output.summaryobject[]Reasoning summary 项。
output.encrypted_contentstring请求 include 时返回的加密 reasoning 内容。
output_textstring可用时的拼接文本输出。
parallel_tool_callsboolean是否允许并行工具调用。
previous_response_idstring|nullPrevious response ID。
promptobject|nullPrompt 模板引用。
prompt.idstringPrompt 模板 ID。
prompt.variablesobjectPrompt 变量。
prompt.versionstringPrompt 版本。
prompt_cache_keystringPrompt cache key。
prompt_cache_retention"in_memory" | "24h"Prompt cache 保留策略。
reasoningobject|null实际使用的 reasoning 配置。
reasoning.context"auto" | "current_turn" | "all_turns"Reasoning context 模式。
reasoning.effort"none" | "minimal" | "low" | "medium" | "high" | "xhigh"Reasoning effort。
reasoning.summary"auto" | "concise" | "detailed" | nullReasoning summary 模式。
safety_identifierstring稳定终端用户标识。
service_tier"auto" | "default" | "flex" | "scale" | "priority"实际使用的服务层级。
status"completed" | "failed" | "in_progress" | "cancelled" | "queued" | "incomplete"响应状态。
storeboolean响应是否被存储。
temperaturenumber采样温度。
textobject文本响应配置。
text.formatobjecttext.verbosity"low" | "medium" | "high"Verbosity 设置。
tool_choicestring | object实际使用的工具选择。
toolsobject[]实际使用的工具定义。
top_logprobsnumberTop logprobs 设置。
top_pnumber核采样设置。
truncation"auto" | "disabled"截断策略。
usageobjectToken 用量。
usage.input_tokensnumber输入 token 数。
usage.input_tokens_detailsobjectusage.output_tokensnumber输出 token 数。
usage.output_tokens_detailsobjectusage.total_tokensnumber总 token 数。
userstring已弃用终端用户标识。
metadataobject附加到响应上的 metadata。
不支持的有状态操作
需要已存储响应状态的请求会返回 501 unsupported_feature,包括:
previous_response_idconversationbackground: truestore: true/v1/responses/{response_id}/v1/responses/{response_id}/input_items/v1/responses/{response_id}/cancel