Skip to main content
POST
创建响应
此接口兼容 OpenAI Responses 协议,用于创建聊天补全请求。

功能特性

  • 支持流式(SSE)和非流式两种响应模式
  • 支持函数调用与工具调用(Function/Tool Calling)
  • 支持结构化输出(JSON Schema)
  • 支持推理模式配置(reasoning_effort)
  • 支持网络搜索选项

使用场景

适用于需要与 OpenAI 兼容模型进行对话交互的场景,包括:
  • 单轮或多轮对话
  • 函数调用与工具编排
  • 结构化 JSON 输出
  • 流式实时响应

认证方式

在请求头中携带 Authorization 字段,格式为 Bearer YOUR_API_KEY
  • 请勿在客户端代码中暴露 API Key,建议通过服务端代理转发请求。
不支持会话状态管理当前 API 不支持 OpenAI Responses API 的服务端状态管理能力。以下字段不受支持:
  • previous_response_id
  • conversation
本接口采用无状态模式运行,不会保存历史 Response,也不会在后续请求中自动携带之前的对话上下文。如需实现多轮对话,请调用方自行维护历史消息,并通过 input 参数显式传递完整上下文。

快速示例

请求头

Authorization
string
默认值:Bearer
必填

API Key token (Bearer sk-xxx)

Content-Type
string
默认值:application/json
示例:

"application/json"

请求体

application/json
input
必填

输入内容,可以是字符串或输入项列表。

model
string
必填

模型 ID,如 gpt-4o、gpt-5 等。

context_management
object[]

上下文管理配置。

max_output_tokens
integer<int64>

最大输出 token 数量(包含可见输出与 reasoning tokens)。

max_tool_calls
integer<int64>

内置工具最大总调用次数。

parallel_tool_calls
boolean

是否启用并行工具调用。

previous_response_id
string

前一次响应 ID,用于多轮对话。

prompt_cache_key
string

Prompt 缓存键,用于替换 user 提升缓存命中率。

prompt_cache_retention
enum<string>

Prompt 缓存保留策略

可用选项:
in_memory,
24h
safety_identifier
string

安全标识符。

service_tier
enum<string>

{auto=auto, default=default, flex=flex, scale=scale, priority=priority}

可用选项:
auto,
default,
flex,
scale,
priority
stream_options
object

流式响应选项,仅在{@code stream: true} 时设置。

tool_choice

工具选择策略:none、auto、required 或包含 type/name 的工具选择对象。

可用选项:
none,
auto,
required
top_logprobs
integer<int64>

每个 token 位置返回的最可能 token 数量(0-20)。

top_p
number

核采样。

background
boolean

是否后台运行响应。

conversation
object

关联会话。可以是会话 ID 字符串,也可以是包含 id 的会话对象{@link ResponseConversationParam}。

include
string[]

额外返回数据项。

instructions
string

系统/开发者指令。

metadata
object

元数据,最多 16 个 key-value 对。

moderation
object

内容审核配置。

prompt
object

可复用 Prompt 模板引用。

reasoning
object

推理模型配置(gpt-5 及 o 系列模型)。

store
boolean
默认值:false

是否存储响应。

stream
boolean
默认值:false

是否启用流式输出(OpenAI Responses API 原生字段,同时用于网关流式判断)。

temperature
number

采样温度。

text
object

文本/结构化输出配置,替代旧的 response_format。

tools
object[]

工具列表,支持 function、web_search_preview、file_search、computer_use_preview 等。

OpenAI Responses API 工具定义基类。支持 function、file_search、web_search_preview 等多种工具类型。

truncation
enum<string>

{auto=auto, disabled=disabled}

可用选项:
auto,
disabled
user
string

用户标识(已废弃,建议使用 safety_identifier / prompt_cache_key)。

响应

200 - application/json
created_at
number

创建时间(Unix 时间戳,秒)

incomplete_details
object

未完成的详情

parallel_tool_calls
boolean

是否启用并行工具调用

tool_choice

工具选择策略

可用选项:
none,
auto,
required
top_p
number

核采样

completed_at
number

完成时间(Unix 时间戳,秒)

max_output_tokens
integer<int64>

最大输出 token 数量

max_tool_calls
integer<int64>

内置工具最大总调用次数

previous_response_id
string

前一次响应 ID

prompt_cache_key
string

Prompt 缓存键

prompt_cache_retention
enum<string>

{in_memory=in_memory, 24h=24h}

可用选项:
in_memory,
24h
safety_identifier
string

安全标识符

service_tier
enum<string>

{auto=auto, default=default, flex=flex, scale=scale, priority=priority}

可用选项:
auto,
default,
flex,
scale,
priority
top_logprobs
integer<int64>

每个 token 位置返回的最可能 token 数量

id
string

响应唯一标识

error
object

错误信息

instructions

系统/开发者指令。可以是字符串,也可以是输入项列表。

metadata
object

元数据,最多 16 个 key-value 对 与OPENAI SDK不一致,与文档一致

model
string

使用的模型 ID

object
string
默认值:response

对象类型,始终为 "response"

output
object[]

输出项列表

temperature
number

采样温度

tools
object[]

工具列表

OpenAI Responses API 工具定义基类。支持 function、file_search、web_search_preview 等多种工具类型。

background
boolean
默认值:false

是否后台运行响应

conversation
object

关联会话

moderation
object

输入/输出内容审核配置

prompt
object

可复用 Prompt 模板引用

reasoning
object

推理模型配置

status
enum<string>

{completed=completed, failed=failed, in_progress=in_progress, cancelled=cancelled, queued=queued, incomplete=incomplete}

可用选项:
completed,
failed,
in_progress,
cancelled,
queued,
incomplete
text
object

文本/结构化输出配置

truncation
enum<string>

{auto=auto, disabled=disabled}

可用选项:
auto,
disabled
usage
object

使用统计信息

user
string

用户标识(已废弃)