API Reference

OpenAI Responses

兼容 OpenAI Responses 协议,适合多模态与结构化输出新接口。

POST https://api.tu-zi.com/v1/responses
预览指南

粘贴给 AI,帮助理解文档并完成接入。 仅包含文档与示例,不包含真实密钥。

预览指南

OpenAI Responses

更新 · 审核信息

接口与鉴权

POST https://api.tu-zi.com/v1/responses

传输方式: json

使用模型调用 API Key。示例凭证为占位符,请从环境变量读取真实密钥。

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

最小请求示例

{
  "model": "YOUR_MODEL",
  "input": "Hello"
}

运行前准备

将 https://api.tu-zi.com 替换为本站地址(不要重复追加 /v1),YOUR_MODEL 替换为模型广场中的完整模型名。Python 示例需要先安装 requests;JavaScript 示例使用 Node.js 20+ 并保存为 .mjs 文件。WebSocket 示例按代码注释安装专用依赖。

先在本站令牌页面创建模型调用密钥,并设置 API_KEY 环境变量;cURL 中的 YOUR_API_KEY 需要替换。上传示例中的 input.png/input.wav 是本地文件,必须提前准备。

首次运行使用最小请求;成功后对照下方响应字段读取结果。异步接口返回任务 ID 后仍需查询,任务提交成功不代表生成已完成。

适用限制

本页是协议基础结构。模型可用参数、枚举、上限和异步行为以该模型“快速上手”为准;示例中的 YOUR_MODEL 必须替换。表中表单初始值不代表上游默认值。

请求体参数

字段类型必填说明与约束
modelstring是要调用的模型名称。 示例: gpt-4.1-mini
inputstring | array是用户输入,可以是纯文本,也可以是结构化数组。 示例: 介绍一下这个模型
streamboolean否是否开启流式返回。 表单初始值(非上游默认值): false 示例: false
temperaturenumber否控制生成随机性。 表单初始值(非上游默认值): 0.7 定义范围: 0 ~ 2 示例: 0.7
max_output_tokensnumber否限制响应的最大输出 token 预算。值过小可能造成回答截断;推理模型的内部思考也可能占用预算,建议为完整可见回答留足空间。 表单初始值(非上游默认值): 512 定义范围: 1 ~ 128000 示例: 512
top_pnumber否核采样概率阈值。 表单初始值(非上游默认值): 1 定义范围: 0 ~ 1 示例: 1
input[]object否数组输入按 type 区分消息、工具结果等条目。
toolsarray否模型支持的工具声明。
tool_choicestring | object否工具选择策略,需模型支持。
textobject否文本或结构化输出配置,需模型支持。

响应字段

字段类型说明与约束
output[]object输出项,包括消息、工具调用等;按 type 解析。
output[].content[].textstring文本输出。
usageobject调用用量。
idstring响应 ID。
statusstring响应状态;需检查失败或未完成状态。
errorobject | null失败时的错误对象。
incomplete_detailsobject | null未完成原因。
output[].typestring区分 message、function_call 等输出项。
usage.input_tokensinteger输入 token 数。
usage.output_tokensinteger输出 token 数。
usage.total_tokensinteger总 token 数。

以下为示例响应,部分接口仅展示主要字段;可选字段不保证出现。

{
  "id": "resp_example",
  "status": "completed",
  "output": [
    {
      "type": "message",
      "content": [
        {
          "type": "output_text",
          "text": "Hello"
        }
      ]
    }
  ]
}

流式响应

stream=true 时按 SSE event/type 处理 response.output_text.delta、response.completed 和 error 等事件。

错误处理与重试

检查 HTTP 状态与该协议的错误对象;不要将不同协议的错误字段混用。401/403 检查凭证与权限,429 退避等待,5xx 检查网关或上游状态。错误正文可能含 error/message/code 等字段,以实际协议为准。

查询可采用有上限的指数退避;创建任务、生成内容、创建或删除密钥等操作不要盲目重试,以免重复计费或重复执行。