API Reference

OpenAI Chat Completions

兼容 OpenAI Chat Completions 协议，适合大多数对话类接入场景。

POST https://api.tu-zi.com/v1/chat/completions

预览指南

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

# OpenAI Chat Completions

兼容 OpenAI Chat Completions 协议，适合大多数对话类接入场景。

## 接口与鉴权

`POST https://api.tu-zi.com/v1/chat/completions`

传输方式: json

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

```http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

## 请求体参数

| 字段 | 类型 | 必填 | 说明与约束 |
| --- | --- | --- | --- |
| model | string | 是 | 要调用的模型名称，应与当前模型保持一致。 示例: gpt-4o-mini |
| messages | array | 是 | 对话消息列表，至少包含一条 user 消息。 示例: [{"role":"user","content":"你好"}] |
| stream | boolean | 否 | 控制响应传输方式。开启后会持续返回增量片段，首字更快；关闭后等待完整结果一次性返回，不会改变模型生成内容。 表单初始值（非上游默认值）: false 示例: false |
| temperature | number | 否 | 控制输出随机性。较低值更稳定、可复现，适合事实问答和代码；较高值更多样，适合创意生成。通常只需调整 temperature 或 top_p 之一。 表单初始值（非上游默认值）: 0.7 定义范围: 0 ~ 2 示例: 0.7 |
| max_tokens | number | 否 | 限制单次请求的最大输出 token 预算。值过小可能截断回答；推理模型还可能占用思考预算，建议预留更大空间。值越大不代表一定生成越长，但可能提高耗时与费用上限。 表单初始值（非上游默认值）: 512 定义范围: 1 ~ 128000 示例: 512 |
| top_p | number | 否 | 控制候选 token 的累计概率范围。值越低输出越集中、稳定，值越高选择越丰富；建议与 temperature 二选一调节。 表单初始值（非上游默认值）: 1 定义范围: 0 ~ 1 示例: 1 |
| frequency_penalty | number | 否 | 根据 token 已出现的频次抑制重复。正值越大越少重复，负值会增强重复倾向；设置过高可能损害连贯性。 表单初始值（非上游默认值）: 0 定义范围: -2 ~ 2 示例: 0 |
| presence_penalty | number | 否 | 只要 token 已出现就施加惩罚。正值鼓励引入新内容，负值鼓励围绕已有内容；设置过高可能导致话题跳跃。 表单初始值（非上游默认值）: 0 定义范围: -2 ~ 2 示例: 0 |
| messages[].role | string | 否 | 消息角色：system、developer、user、assistant、tool，支持情况取决于模型。 |
| messages[].content | string \| array \| null | 否 | 文本或多模态内容块；图片使用 image_url，工具调用消息可为空。 |
| tools | array | 否 | 工具声明；仅在模型支持工具调用时使用。函数定义包含 name、description、parameters（JSON Schema）。 |
| tool_choice | string \| object | 否 | 工具选择策略，必须与 tools 和模型能力匹配。 |
| response_format | object | 否 | 结构化输出配置；json_object / json_schema 等取决于模型支持。 |
| stream_options | object | 否 | 流式附加配置，include_usage 需端点和模型支持。 |

## 最小请求示例

```json
{
  "model": "YOUR_MODEL",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false
}
```

## 运行前准备

将 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 后仍需查询，任务提交成功不代表生成已完成。

## 代码示例

### curl

```bash
curl --request POST 'https://api.tu-zi.com/v1/chat/completions' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "YOUR_MODEL",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false
}'
```

### python

```python
import json
import os
import requests

url = "https://api.tu-zi.com/v1/chat/completions"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\",\"Content-Type\":\"application/json\"}")
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
payload = json.loads("{\"model\":\"YOUR_MODEL\",\"messages\":[{\"role\":\"user\",\"content\":\"Hello\"}],\"stream\":false}")
response = requests.request("POST", url, headers=headers, json=payload, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("error")):
    raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(result)  # Also inspect protocol-specific status/code fields.
```

### javascript

```javascript
// Node.js 20+
const url = "https://api.tu-zi.com/v1/chat/completions";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
};
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify({
  "model": "YOUR_MODEL",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false
}) });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.error) throw new Error(JSON.stringify(result));
console.log(result); // Also inspect protocol-specific status/code fields.
```

## 响应字段

| 字段 | 类型 | 说明与约束 |
| --- | --- | --- |
| choices[].message.content | string \| array \| null | 输出内容；工具调用时可为空。 |
| choices[].finish_reason | string | 结束原因。 |
| usage | object | 本次调用用量。 |
| id | string | 响应 ID。 |
| model | string | 响应的模型标识。 |
| choices[].message.role | string | 输出消息角色。 |
| choices[].message.tool_calls[] | object | 工具调用；按 id、type、function.name 和 function.arguments 处理。arguments 是 JSON 字符串，执行工具前需校验。 |
| usage.prompt_tokens | integer | 输入 token 数。 |
| usage.completion_tokens | integer | 输出 token 数。 |
| usage.total_tokens | integer | 总 token 数。 |

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

```json
{
  "id": "example",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "Hello"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 5,
    "completion_tokens": 1,
    "total_tokens": 6
  }
}
```

## 流式响应

stream=true 时返回 SSE；读取 choices[].delta，遇到 data: [DONE] 结束。

## 错误处理与重试

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

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

## 适用限制

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

## 文档依据

定义版本: 1

审核日期: 2026-11-02

来源: https://api.tu-zi.com/docs/api/reference-relay-openai

关联协议说明: https://api.tu-zi.com/docs/api/openai

本文只包含接口文档和示例。真实密钥、账号数据及用户请求内容不包含在复制内容中。

更新 2026-11-02 · 审核信息 2026-11-02

接口与鉴权

POST https://api.tu-zi.com/v1/chat/completions

传输方式: json

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

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

最小请求示例

{
  "model": "YOUR_MODEL",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false
}

运行前准备

将 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 必须替换。表中表单初始值不代表上游默认值。

请求体参数

字段	类型	必填	说明与约束
model	string	是	要调用的模型名称，应与当前模型保持一致。示例: gpt-4o-mini
messages	array	是	对话消息列表，至少包含一条 user 消息。示例: [{"role":"user","content":"你好"}]
stream	boolean	否	控制响应传输方式。开启后会持续返回增量片段，首字更快；关闭后等待完整结果一次性返回，不会改变模型生成内容。表单初始值（非上游默认值）: false 示例: false
temperature	number	否	控制输出随机性。较低值更稳定、可复现，适合事实问答和代码；较高值更多样，适合创意生成。通常只需调整 temperature 或 top_p 之一。表单初始值（非上游默认值）: 0.7 定义范围: 0 ~ 2 示例: 0.7
max_tokens	number	否	限制单次请求的最大输出 token 预算。值过小可能截断回答；推理模型还可能占用思考预算，建议预留更大空间。值越大不代表一定生成越长，但可能提高耗时与费用上限。表单初始值（非上游默认值）: 512 定义范围: 1 ~ 128000 示例: 512
top_p	number	否	控制候选 token 的累计概率范围。值越低输出越集中、稳定，值越高选择越丰富；建议与 temperature 二选一调节。表单初始值（非上游默认值）: 1 定义范围: 0 ~ 1 示例: 1
frequency_penalty	number	否	根据 token 已出现的频次抑制重复。正值越大越少重复，负值会增强重复倾向；设置过高可能损害连贯性。表单初始值（非上游默认值）: 0 定义范围: -2 ~ 2 示例: 0
presence_penalty	number	否	只要 token 已出现就施加惩罚。正值鼓励引入新内容，负值鼓励围绕已有内容；设置过高可能导致话题跳跃。表单初始值（非上游默认值）: 0 定义范围: -2 ~ 2 示例: 0
messages[].role	string	否	消息角色：system、developer、user、assistant、tool，支持情况取决于模型。
messages[].content	string \| array \| null	否	文本或多模态内容块；图片使用 image_url，工具调用消息可为空。
tools	array	否	工具声明；仅在模型支持工具调用时使用。函数定义包含 name、description、parameters（JSON Schema）。
tool_choice	string \| object	否	工具选择策略，必须与 tools 和模型能力匹配。
response_format	object	否	结构化输出配置；json_object / json_schema 等取决于模型支持。
stream_options	object	否	流式附加配置，include_usage 需端点和模型支持。

响应字段

字段	类型	说明与约束
choices[].message.content	string \| array \| null	输出内容；工具调用时可为空。
choices[].finish_reason	string	结束原因。
usage	object	本次调用用量。
id	string	响应 ID。
model	string	响应的模型标识。
choices[].message.role	string	输出消息角色。
choices[].message.tool_calls[]	object	工具调用；按 id、type、function.name 和 function.arguments 处理。arguments 是 JSON 字符串，执行工具前需校验。
usage.prompt_tokens	integer	输入 token 数。
usage.completion_tokens	integer	输出 token 数。
usage.total_tokens	integer	总 token 数。

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

{
  "id": "example",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "Hello"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 5,
    "completion_tokens": 1,
    "total_tokens": 6
  }
}

流式响应

stream=true 时返回 SSE；读取 choices[].delta，遇到 data: [DONE] 结束。

错误处理与重试

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

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

文档信息与来源

文档依据

定义版本: 1

审核日期: 2026-11-02

来源: https://api.tu-zi.com/docs/api/reference-relay-openai

关联协议说明: https://api.tu-zi.com/docs/api/openai

本文只包含接口文档和示例。真实密钥、账号数据及用户请求内容不包含在复制内容中。

请求示例

curl --request POST 'https://api.tu-zi.com/v1/chat/completions' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "YOUR_MODEL",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false
}'

import json
import os
import requests

url = "https://api.tu-zi.com/v1/chat/completions"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\",\"Content-Type\":\"application/json\"}")
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
payload = json.loads("{\"model\":\"YOUR_MODEL\",\"messages\":[{\"role\":\"user\",\"content\":\"Hello\"}],\"stream\":false}")
response = requests.request("POST", url, headers=headers, json=payload, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("error")):
    raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(result)  # Also inspect protocol-specific status/code fields.

// Node.js 20+
const url = "https://api.tu-zi.com/v1/chat/completions";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
};
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify({
  "model": "YOUR_MODEL",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false
}) });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.error) throw new Error(JSON.stringify(result));
console.log(result); // Also inspect protocol-specific status/code fields.