apimaxDocs
文档定价控制台
API 参考接入指南用户指南更新日志

音乐系列

图像系列

视频系列

任务管理

错误码参考查询任务状态GET

账户管理

查询额度使用情况GET

文档 / 账户管理

账户管理GET

查询额度使用情况

使用 API Key 查询当前令牌及所属用户的剩余 credits、已用 credits 和无限额度状态。

GEThttps://api.apimax.ai/v1/usage
试一试
Bearer API KeyJSON服务端调用

用途#

查询当前 API Key 对应的令牌额度,以及该令牌所属用户的账户额度。接口同时返回令牌与用户两个维度的剩余 credits 和累计已用 credits,适合余额展示、调用前检查和低余额告警。

原 /api/usage/token/ 已移除,请统一使用本接口。

请求示例#

cURL
curl --request GET \
  --url https://api.apimax.ai/v1/usage \
  --header 'Authorization: Bearer sk-xxxx'

鉴权与参数#

本接口使用与模型调用相同的 API Key 鉴权,不需要后台登录态 access token。

参数位置类型必填说明
Authorizationheaderstring是Bearer <API Key>,即后台创建令牌时生成的 sk- 开头字符串

接口没有 query 或 body 参数。API Key 必须处于启用状态且未过期,并满足令牌 IP 与分组限制。

成功响应#

200
{
  "success": true,
  "message": "",
  "data": {
    "token": {
      "remaining_credits": 7.6,
      "used_credits": 2.4,
      "unlimited_credits": false
    },
    "user": {
      "remaining_credits": 12.5,
      "used_credits": 3.5
    }
  }
}

响应字段#

字段类型说明
successbool请求是否成功
messagestring成功时为空字符串
data.token.remaining_creditsnumber当前 API 令牌的剩余 credits
data.token.used_creditsnumber当前 API 令牌的累计已用 credits
data.token.unlimited_creditsbool当前令牌是否为无限额度令牌
data.user.remaining_creditsnumber令牌所属用户的账户剩余 credits
data.user.used_creditsnumber令牌所属用户的账户累计已用 credits

Credits 换算#

响应中的 credits 由内部 quota 除以系统 QuotaPerUnit 得到。当前默认配置为 500000 quota = 1 credit:

  • 3800000 quota 返回为 7.6 credits
  • 实际扣费仍按模型价格、输入输出 token、分组倍率及其他计费规则结算

unlimited_credits=true 表示令牌不受令牌剩余额度限制;remaining_credits 仍作为统计参考。用户账户额度仍按系统计费规则管理。

错误响应#

HTTP说明
401API Key 缺失、无效、已禁用、已过期或额度已耗尽
403用户被禁用、来源 IP 不在令牌白名单内,或令牌分组不可用
429请求频率超过限制
500服务内部查询失败
401
{
  "error": {
    "code": "",
    "message": "Invalid token (request id: ...)",
    "type": "new_api_error"
  }
}

下一步

全部文档
Relink 音频链接根据 Suno clip_id 同步获取可直接使用的音频链接。润色风格标签把风格标签和歌词润色扩写成更完整的风格描述。获取风格灵感建议获取 Suno 上游的随机风格或灵感建议。方法一:从已有歌曲创建音色使用本池已生成的歌曲 clip 直接创建人声音色。上传音频把用户音频导入为 Suno 自有 clip,返回异步上传任务 ID;带 copyright=true 时改走版权音乐管线。获取 MIDI为本服务已生成的 clip 获取 MIDI 文件。
本页导航
概览用途请求示例鉴权与参数成功响应响应字段Credits 换算错误响应下一步
API

GET /v1/usage