查询余额

GET/user/balance

鉴权: Bearer API Key
执行方式: 按所调用的完整地址执行

查看调用示例

接口说明

使用 Bearer API Key 只读查询通用余额；不会发起模型调用，不刷新 Key 使用时间，也不产生计费。

请求

请求地址

方法：GET
鉴权：Authorization: Bearer ${TOKENFACTORY_API_KEY}

请求头

名称	必填	值或类型	说明
`Authorization`	是	`Bearer ${TOKENFACTORY_API_KEY}`	Token Factory API Key

路径参数：无

查询参数：无

请求字段：无

请求报文：无请求体

响应

成功状态：200

响应头

名称	值或类型	说明
`Content-Type`	`application/json`	响应媒体类型

响应字段

字段	类型	必填	说明	示例或约束
`balance`	`number`	是	人民币元；可为 0 或在途调用形成的有限负数。	示例：12.345678
`is_active`	`boolean`	是	API Key 所属账户通过鉴权时为 true。	示例：true
`unit`	`string`	是	余额货币单位，固定为人民币。	示例："CNY"；可选值："CNY"

返回报文

媒体类型：application/json

json

{
  "balance": 12.345678,
  "is_active": true,
  "unit": "CNY"
}

错误

适用完整地址	状态	错误码	常见触发	重试	建议动作	结果风险
`https://api.tokenfactory.cn/v1/user/balance`	`401`	`invalid_api_key`	Authorization 缺失、Bearer 格式错误、Key 不可用或账户未实名	否	检查 Bearer API Key、Key 状态与实名状态	无
`https://api.tokenfactory.cn/v1/user/balance`	`500`	`internal_error`	平台内部出现未预期错误	视情况	确认未收到有效结果并记录请求时间后再决定是否重试	中到高

错误返回报文

适用完整地址

https://api.tokenfactory.cn/v1/user/balance

HTTP 401；Content-Type: application/json

json

{
  "error": {
    "code": "invalid_api_key",
    "message": "Authorization 缺失、Bearer 格式错误、Key 不可用或账户未实名",
    "type": "authentication_error"
  }
}

限制与计费

适用完整地址	限制或计费说明
`https://api.tokenfactory.cn/v1/user/balance`	只读查询，不改变 API Key 状态或余额，不产生计费，也不写入用量记录。 balance 以人民币元返回，可为 0 或有限负数。此接口只读；返回当次查询快照，不代表实时账单明细。

调用示例

cURL · https://api.tokenfactory.cn/v1/user/balance

curl --request GET "https://api.tokenfactory.cn/v1/user/balance" --silent --show-error --fail-with-body --max-time 60 --header "Authorization: Bearer ${TOKENFACTORY_API_KEY}"

查询余额 ​

接口说明 ​

请求 ​

请求头 ​

响应 ​

响应头 ​

响应字段 ​

返回报文 ​

错误 ​

错误返回报文 ​

适用完整地址 ​

限制与计费 ​

调用示例 ​

cURL · https://api.tokenfactory.cn/v1/user/balance ​

相关说明 ​