# 局部修改 API Key

只更新显式提供的字段；未提供字段保持原值，0 和 false 会被保留。

## 接口与鉴权

`PATCH https://api.tu-zi.com/api/token/{id}`

传输方式: json

使用账号系统令牌与 New-Api-User（账号用户 ID）；也可使用本站有效登录态。系统令牌在个人设置中管理，不能替换成模型调用 API Key。

此接口还支持经授权的 OAuth 访问令牌，所需 scope: `token:write`

```http
Authorization: Bearer YOUR_SYSTEM_TOKEN
New-Api-User: YOUR_USER_ID
Content-Type: application/json
```

## 路径参数

| 字段 | 类型 | 必填 | 说明与约束 |
| --- | --- | --- | --- |
| id | integer | 是 | 当前用户的令牌 ID。 示例: 123 |

## 请求体参数

| 字段 | 类型 | 必填 | 说明与约束 |
| --- | --- | --- | --- |
| name | string | 否 | 名称不能为空，最长 50 个 Unicode 字符；与创建和 PUT 的 50 字节限制不同。 示例: demo |
| expired_time | integer | 否 | Unix 秒，-1 表示不过期；建议显式传入。 示例: -1 |
| remain_quota | integer | 否 | 初始额度，不能为负。 示例: 1000 |
| unlimited_quota | boolean | 否 | 是否不限额度。 示例: false |
| group | string | 否 | 用户有权使用的分组，多个用逗号分隔。 示例:  |
| model_limits_enabled | boolean | 否 | 是否启用模型限制。 示例: false |
| model_limits | string | 否 | 逗号分隔的模型 ID。 示例:  |
| allow_ips | string | 否 | 允许的 IP/CIDR，每行一个。 示例:  |
| exclude_ips | string | 否 | 拒绝的 IP/CIDR，每行一个。 示例:  |
| status | integer | 否 | 1 启用或 2 禁用。 |

## 最小请求示例

```json
{
  "name": "renamed-key",
  "unlimited_quota": false,
  "remain_quota": 0
}
```

## 运行前准备

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

先设置环境变量 SYSTEM_TOKEN、USER_ID；不要把系统令牌放进前端网页。cURL 中的 YOUR_SYSTEM_TOKEN 和 YOUR_USER_ID 需要替换。

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

## 代码示例

### curl

```bash
curl --request PATCH 'https://api.tu-zi.com/api/token/123' \
  --header 'Authorization: Bearer YOUR_SYSTEM_TOKEN' \
  --header 'New-Api-User: YOUR_USER_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "renamed-key",
  "unlimited_quota": false,
  "remain_quota": 0
}'
```

### python

```python
import json
import os
import requests

url = "https://api.tu-zi.com/api/token/123"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_SYSTEM_TOKEN\",\"New-Api-User\":\"YOUR_USER_ID\",\"Content-Type\":\"application/json\"}")
headers["Authorization"] = "Bearer " + os.environ["SYSTEM_TOKEN"]
headers["New-Api-User"] = os.environ["USER_ID"]
payload = json.loads("{\"name\":\"renamed-key\",\"unlimited_quota\":false,\"remain_quota\":0}")
response = requests.request("PATCH", 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/api/token/123";
const headers = {
  "Authorization": "Bearer YOUR_SYSTEM_TOKEN",
  "New-Api-User": "YOUR_USER_ID",
  "Content-Type": "application/json"
};
headers.Authorization = 'Bearer ' + process.env.SYSTEM_TOKEN;
headers['New-Api-User'] = process.env.USER_ID;
const response = await fetch(url, { method: "PATCH", headers, body: JSON.stringify({
  "name": "renamed-key",
  "unlimited_quota": false,
  "remain_quota": 0
}) });
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.
```

## 响应字段

| 字段 | 类型 | 说明与约束 |
| --- | --- | --- |
| success | boolean | 业务是否成功；不能只判断 HTTP 状态。 |
| message | string | 结果或错误说明。 |
| data | object | 令牌配置，key 脱敏。 |
| data.is_expired | boolean | 是否过期。 |

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

```json
{
  "success": true,
  "message": "",
  "data": {
    "id": 123,
    "name": "demo",
    "key": "sk-****",
    "remain_quota": 1000,
    "unlimited_quota": false,
    "expired_time": -1,
    "is_expired": false
  }
}
```

## 错误处理与重试

同时检查 HTTP 状态和 success。业务校验失败可能仍返回 HTTP 200，正文为 {"success":false,"message":"..."}；部分错误有 error.code。鉴权可能返回 401/403，限流可能返回 429。不要仅凭 HTTP 200 判断成功。

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

## 适用限制

至少提供一个支持字段；不接受 null、未知字段或超过 64 KiB 的请求体。name 不能为空，最长 50 个字符。

## 文档依据

定义版本: 1

审核日期: 2026-11-02

来源: https://api.tu-zi.com/docs/api/reference-token-patch

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