跳转到主要内容
GET
https://api.apimart.ai
/
v1
/
user
/
balance
curl --request GET \
  --url 'https://api.apimart.ai/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "unlimited_quota": false
}
获取当前用户账户的剩余余额和已使用余额。此接口返回用户级别的余额信息，与具体令牌无关，用于查看用户账户的总体余额。 
curl --request GET \
  --url 'https://api.apimart.ai/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "unlimited_quota": false
}

​
认证

​
Authorization
string
required
所有接口均需要使用 Bearer Token 进行认证获取 API Key：访问 API Key 管理页面 获取您的 API Key使用时在请求头中添加：
Authorization: Bearer YOUR_API_KEY

​
接口端点

GET /v1/user/balance
GET /user/balance
两个端点功能相同，可以任选其一使用。

​
响应

​
success
boolean
请求是否成功
​
message
string
错误信息（仅失败时返回）
​
remain_balance
float
用户剩余余额（成功时返回）。当 unlimited_quota 为 true 时，该值为 -1
​
used_balance
float
用户已使用余额（成功时返回）
​
unlimited_quota
boolean
是否为无限额度用户。true 表示无限额度，false 表示有限额度

​
令牌余额 vs 用户余额

对比项令牌余额 (/v1/balance)用户余额 (/v1/user/balance)
作用范围单个令牌整个用户账户
数据来源Token 的 RemainQuota 和 UsedQuotaUser 的 quota 和 used_quota
使用场景监控单个 API Key 的使用情况查看用户账户总体余额
受限于令牌级别的额度限制用户级别的额度限制

​
使用场景

  • 查看用户账户的总体余额
  • 用于充值提醒和余额告警
  • 在用户控制面板显示账户余额
余额单位说明余额数值的单位取决于系统配置：
  • USD - 美元
  • CNY - 人民币
  • Tokens - Token 数量
无限额度用户当用户被设置为无限额度时：
  • unlimited_quota 字段返回 true
  • remain_balance 字段返回 -1
  • 该用户不受额度限制，可无限使用

​
常见错误

错误信息原因解决方案
无 Authorization 头未提供 Authorization 请求头添加 Authorization: Bearer sk-xxxxx 请求头
获取用户额度失败用户不存在检查令牌关联的用户是否存在
获取已使用额度失败数据库查询错误联系管理员检查系统状态
安全提示API Key 相当于密码，请妥善保管，不要泄露给他人。生产环境请务必使用 HTTPS。