# 查询当前 Key 用量

查询当前 Key 用量。字段和权限以本站接口实现为准。

## 接口与鉴权

`GET https://api.tu-zi.com/api/usage/token/`

传输方式: json

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

```http
Authorization: Bearer YOUR_API_KEY
```

## 请求参数

此接口无需请求体；按上述鉴权要求发送请求。

## 运行前准备

将 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 GET 'https://api.tu-zi.com/api/usage/token/' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

### python

```python
import json
import os
import requests

url = "https://api.tu-zi.com/api/usage/token/"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\"}")
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
response = requests.request("GET", url, headers=headers, 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/usage/token/";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY"
};
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const response = await fetch(url, { method: "GET", headers });
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.
```

## 响应字段

| 字段 | 类型 | 说明与约束 |
| --- | --- | --- |
| code | boolean | 成功标识，注意不是 success 字段。 |
| message | string | 结果说明。 |
| data.object | string | 固定 token_usage。 |
| data.name | string | 令牌名称。 |
| data.total_granted | integer | 剩余额度与已用额度之和。 |
| data.total_used | integer | 已用额度。 |
| data.total_available | integer | 剩余额度。 |
| data.unlimited_quota | boolean | 是否不限额度。 |
| data.model_limits | object | 模型限制映射。 |
| data.model_limits_enabled | boolean | 是否启用模型限制。 |
| data.expires_at | integer | Unix 秒；0 表示不过期。 |

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

```json
{
  "code": true,
  "message": "ok",
  "data": {
    "object": "token_usage",
    "name": "demo",
    "total_granted": 1000,
    "total_used": 100,
    "total_available": 900,
    "unlimited_quota": false,
    "model_limits": {},
    "model_limits_enabled": false,
    "expires_at": 0
  }
}
```

## 错误处理与重试

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

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

## 文档依据

定义版本: 1

审核日期: 2026-11-02

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

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