跳转到主要内容
POST
  • OpenAI 兼容的 Responses API 格式
  • 支持纯文本输入和结构化多模态输入
  • 所选模型可用时,支持网页搜索、函数调用等工具
  • 支持完整 JSON 响应和 SSE 流式输出

使用示例

基础文本

多模态输入

网页搜索

流式输出

cURL

流式输出

当 stream 为 true 时,接口返回 text/event-stream。事件以 SSE data: 行发送,并以 data: [DONE] 结束。 常见事件类型包括:
  • response.created
  • response.output_item.added
  • response.output_text.delta
  • response.output_text.done
  • response.completed
  • response.failed

注意事项

  • 工具是否可用取决于所选模型。如果模型不支持请求的工具,请求可能返回错误。
  • 图像输入使用公开 URL 时,模型服务必须能访问该 URL。
  • Base64 图像必须带完整的 Data URI 前缀,例如 data:image/png;base64,。
  • 内容块的顺序会影响模型理解。尽可能把文本指令放在图像之前。

响应

非流式请求直接返回 Responses 对象,不带 code / data 包装。生成的文本位于 output[].content[] 中 type: "output_text" 的条目里。

流式输出

设置 "stream": true 时,响应为 text/event-stream。每个事件是一行 data:,其 JSON 中的 type 表示事件名称,流以 data: [DONE] 结束:
  • 拼接 response.output_text.delta 事件即可得到完整文本。
  • response.completed 携带最终的 response 对象,包括 usage。
  • 事件只以 data: 行发送,没有单独的 event: 行。请从 type 读取事件名称。

错误

  • 401:缺少 API Key 或 API Key 无效。
  • 400:参数无效,或模型不支持 Responses。错误信息会列出支持的 URI。
  • 404:未知的 model id。
响应体示例见错误码,哪些模型支持此格式见 LLM 模型。

授权

Authorization
string
header
必填

所有 API 接口都需要 Bearer Token 认证。

创建 API Key:登录 PoYo,进入 仪表盘 → API 密钥(poyo.ai/zh/dashboard/api-key),点击创建 Key。

在请求头中添加:

请求体

application/json
model
string
必填

模型名称。

示例:

"gpt-5.2"

input
必填

纯文本输入或结构化输入项数组。

示例:

"Write a product tagline in one sentence."

instructions
string

引导模型响应的系统或开发者指令。

tools
object[]

模型可用的工具。工具支持情况取决于所选模型。

tool_choice

控制模型如何选择工具。

示例:

"auto"

max_output_tokens
integer

生成的最大输出 token 数。

必填范围: x >= 1
示例:

200

max_tokens
integer

用于兼容旧版的最大输出 token 字段。

必填范围: x >= 1
示例:

200

stream
boolean
默认值:false

是否以 SSE 格式流式输出。

示例:

false

store
boolean

支持时,是否存储该响应。

示例:

false

reasoning
object

推理配置,所选模型支持时可用。

示例:
text
object

文本输出配置,例如支持时的结构化输出格式选项。

metadata
object

请求的自定义元数据键值对。

previous_response_id
string

用于继续对话的上一个响应 ID。

include
string[]

支持时,需要额外包含的响应字段。

parallel_tool_calls
boolean

是否允许模型并行调用多个工具。

truncation
string

长上下文的截断行为,支持时可用。

示例:

"auto"

user
string

最终用户标识符,用于滥用监控和请求追踪。

background
boolean

支持时,是否以后台模式运行响应。

service_tier
string

服务层级选择,支持时可用。

示例:

"auto"

prompt
object

提示词对象,所选模型支持时可用。

temperature
number

控制输出的随机性,范围 0-2。

必填范围: 0 <= x <= 2
示例:

1

top_p
number

核采样参数,范围 0-1。

必填范围: 0 <= x <= 1
示例:

1

响应

响应已创建

响应对象。

id
string
示例:

"resp_9876543210"

object
string
示例:

"response"

created_at
integer
示例:

1677652288

status
string
示例:

"completed"

model
string
示例:

"gpt-5.2"

output
object[]
usage
object

token 用量统计。