API Reference

按 Key 查询兼容用量

按 Key 查询兼容用量;以下契约按本站当前实现核对。

GET https://api.tu-zi.com/api/token/key/{key}
预览指南

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

预览指南

按 Key 查询兼容用量

更新 · 审核信息

接口与鉴权

GET https://api.tu-zi.com/api/token/key/{key}

传输方式: json

  • 旧兼容查询:路径携带待查询的模型调用 API Key,并提供所属账号的 New-Api-User;也接受 Rix-Api-User。
  • 无需额外 Authorization。Key 与用户 ID 必须匹配。
  • URL 会包含密钥,请避免访问日志记录完整 URL;新接入优先使用 /api/usage/token/ 的 Bearer 鉴权。
New-Api-User: YOUR_USER_ID

调用准备

  • 示例使用本站地址;调用其他站点时,仅替换站点地址,保留完整接口路径。
  • 设置环境变量 API_KEY、USER_ID;cURL 中的 YOUR_USER_ID 替换为密钥所属账号 ID。

适用限制

  • 余额采用原始 quota;展示金额须使用站点换算配置,不硬编码美元或换算比例。
  • 用户 ID 缺失/不匹配或 Key 无效返回 401;输入为空可能返回 success=false。
  • 此接口是兼容查询,不创建或恢复 Key。

如何判断调用成功

先检查 HTTP 状态,再检查正文的业务状态和所需结果字段,不能只看 HTTP 200 或脚本退出码。

路径参数

字段类型必填说明与约束
keystring是待查询的模型 API Key,可带 sk- 前缀。 示例: YOUR_KEY

响应字段

字段类型说明与约束
codeboolean成功为 true。
data.objectstring固定为 token_usage。
data.namestring令牌名称。
data.total_grantedintegerremain_quota + used_quota,原始额度单位。
data.total_usedinteger已使用额度。
data.total_availableinteger剩余额度。
data.unlimited_quotaboolean是否无限额度。
data.expires_atintegerUnix 秒;0 表示不限期。
data.model_limitsobject模型限制集合。
data.model_limits_enabledboolean是否启用模型限制。

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

{
  "code": true,
  "message": "ok",
  "data": {
    "object": "token_usage",
    "total_granted": 1000000,
    "total_used": 500000,
    "total_available": 500000,
    "unlimited_quota": false,
    "expires_at": 0,
    "name": "Example token",
    "model_limits": {},
    "model_limits_enabled": false
  }
}

错误处理与重试

检查 HTTP 状态与该协议的错误对象;不要将不同协议的错误字段混用。

  • 401/403: 检查凭证与权限。
  • 429: 区分临时限流、额度不足与服务容量,只有临时故障适合有限退避。
  • 5xx: 检查网关、上游及模型/渠道配置。

错误正文可能含 error/message/code 等字段,以实际协议为准。

  • 查询遇到临时错误时可采用有上限的指数退避;参数、鉴权、额度或配置问题先修复再请求。
  • 创建任务、生成内容、创建或删除密钥等操作不要盲目重试,以免重复计费或重复执行。