Skip to content

Responses API

接口:

text
POST /v1/responses

SDK:

python
client.responses.create(...)

请求字段

字段类型必填说明
modelstring使用 /v1/models 返回的模型 ID
inputstring/array字符串或 OpenAI message 数组
instructionsstring系统指令
max_output_tokensnumber最大输出 token 数
temperaturenumber采样温度
top_pnumber核采样参数
streambooleantrue 时返回 Responses SSE
toolsarray支持 function tools
tool_choicestring/object支持 autononerequired 和指定函数
metadataobject请求元数据

响应字段

非流式返回 Responses 风格对象:

字段说明
idresponse ID
objectresponse
statuscompletedcancelled
model响应模型
output输出数组
output_textSDK 侧可聚合文本
usagetoken 用量

流式返回 Responses SSE。事件类型:

事件说明
response.created请求已创建,包含 response.id(取消请求需用此 id)
response.output_item.added输出项开始
response.content_part.added内容块开始
response.output_text.delta文本增量
response.output_text.done文本输出结束
response.content_part.done内容块结束
response.output_item.done输出项结束
response.completed正常完成
response.cancelled请求被取消(output 可能为空)
response.failed请求失败,payload 含 error.code / error.message

取消请求

接口:

text
POST /v1/responses/{response_id}/cancel

SDK:

python
client.responses.cancel("resp_xxx")

HTTP:

bash
curl -X POST https://llm.xiaoyue9527.xyz/v1/responses/resp_xxx/cancel \
  -H 'Authorization: Bearer sk-gtw-REPLACE_ME'

边界

边界说明
previous_response_id暂不支持
background mode暂不支持
文件输入暂不支持
内置工具暂不支持
取消范围仅可取消当前进程内仍活跃的流式 Responses 请求;取消凭证 response_id 需从 response.created 事件获取
断流缓存GET /v1/responses/{request_id} 目前仅命中 Chat/Messages 流式写入的缓存;Responses 流式请求暂不写入断流缓存,断流后无法凭 request_id 取回,客户端需自行重试

示例

bash
curl -N https://llm.xiaoyue9527.xyz/v1/responses \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sk-gtw-REPLACE_ME' \
  --data-raw '{
    "model": "qwen3.6-plus",
    "input": "解释什么是 RESTful API",
    "max_output_tokens": 2048,
    "stream": true
  }'

OpenAI-compatible API documentation.