zhAPI 接口文档文本系列OpenAI 原生协议POSTResponses
文本系列POSTResponses 路径
API 接口文档

Responses

POSThttps://api.tokenbay.com/v1/responses

OpenAI Responses API 与 Responses 压缩入口

Responses 路径

TokenBay 当前提供标准 Responses 路径与 Responses 压缩路径。

POST/v1/responses
POST/v1/responses/compact

请求

字段
modelstringRequired

线上 Models 页面或控制台展示的可用模型 ID。

inputstring | array | objectRequired

Responses API 输入,可为纯文本或多轮/多模态输入。

input[].rolestringOptional

输入消息角色,如 user、assistant、system。

input[].contentstring | array<object>Optional

文本或多模态内容块。

content[].typestringOptional

内容块类型,如 input_text、input_image、input_file。

content[].textstringOptional

文本内容。

content[].image_urlstringOptional

图片 URL 或 data URL。

content[].file_id / filenamestringOptional

文件输入标识;支持情况由上游决定。

instructionsstringOptional

系统级或开发者级指令。

streambooleanOptional

设为 true 时返回 Responses SSE 事件。

max_output_tokensintegerOptional

最大输出 token 数。

temperature / top_pnumberOptional

采样参数。

text / reasoningobjectOptional

结构化文本输出和 reasoning 相关配置。

text.format.typestringOptional

文本格式,如 text、json_schema 等。

text.format.schemaobjectOptional

结构化输出 schema。

reasoning.effortstringOptional

推理强度。

reasoning.summarystringOptional

是否请求 reasoning 摘要;支持情况按模型而定。

tools / tool_choicearray<object> | object | stringOptional

工具调用配置。

tools[].typestringOptional

工具类型,如 function、web_search、file_search、computer_use 等。

tools[].namestringOptional

工具名称。

tools[].parametersobjectOptional

函数工具参数 schema。

tool_choicestring | objectOptional

auto、none、required,或指定工具。

parallel_tool_callsbooleanOptional

是否允许并行工具调用。

previous_response_idstringOptional

用于延续上一轮 Responses 上下文。

includearray<string>Optional

要求上游附带额外输出片段。

store / metadata / userboolean | object | stringOptional

存储与客户端侧追踪字段;不要放入敏感数据。

响应

字段

响应保持 Responses API 形态;流式调用返回 Responses SSE 事件。

idstringOptional

Responses 响应 ID。

objectstringOptional

响应对象类型。

modelstringOptional

实际响应模型名。

output[]array<object>Optional

模型输出块,可能包含 message、tool_call、reasoning 等类型。

output[].typestringOptional

输出块类型,如 message、function_call、reasoning、tool_result。

output[].rolestringOptional

消息块角色。

output[].content[]array<object>Optional

输出内容块。

content[].typestringOptional

内容类型,如 output_text、refusal、annotation。

content[].textstringOptional

输出文本。

output[].call_idstringOptional

工具调用 ID。

output[].argumentsstring | objectOptional

工具调用参数。

usageobjectOptional

输入、输出和总 token 用量,按上游支持情况返回。

usage.input_tokensintegerOptional

输入 token 数。

usage.output_tokensintegerOptional

输出 token 数。

usage.total_tokensintegerOptional

总 token 数。

相关页面