跳转到主要内容
GET
/
api
/
v1
/
generate
/
credit
获取剩余积分
curl --request GET \
  --url https://api.api.box/api/v1/generate/credit \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "msg": "success",
  "data": 100
}

​
用法指南

  • 在生成音乐、歌词或使用其他处理功能时会消耗积分。
  • 此接口允许您在启动任务前检查当前积分余额。
  • 返回一个表示您可用积分的整数值。
  • 无需参数；通过API密钥进行身份验证即可。

​
开发者说明

  1. 定期监控您的积分余额以避免服务中断。
  2. 如果积分不足，生成任务将失败并返回错误代码 429。
  3. 考虑在开始成本较高的生成操作之前集成此检查。
  4. 此接口轻量级，可根据需要频繁调用。

Authorizations

​
Authorization
string
header
required

🔑 API 认证说明

所有接口都需要通过 Bearer Token 方式进行认证。

获取 API Key

  1. 访问 API Key 管理页面 获取您的 API Key

使用方式

在请求头中添加：

Authorization: Bearer YOUR_API_KEY

⚠️ 注意：

  • 请妥善保管您的 API Key，不要泄露给他人
  • 如果怀疑 API Key 泄露，请立即在管理页面重置

Response

请求成功

​
code
enum<integer>

状态码说明

  • ✅ 200 - 请求成功
  • ⚠️ 400 - 参数错误
  • ⚠️ 401 - 没有访问权限
  • ⚠️ 404 - 请求方式或者路径错误
  • ⚠️ 405 - 调用超过限制
  • ⚠️ 413 - 主题或者prompt过长
  • ⚠️ 429 - 积分不足
  • ⚠️ 430 - 您的调用频率过高。请稍后再试。
  • ⚠️ 455 - 网站维护
  • ❌ 500 - 服务器异常
Available options:
200,
400,
401,
404,
405,
413,
429,
430,
455,
500
Example:

200

​
msg
string

当 code != 200 时，展示错误信息

Example:

"success"

​
data
integer

您账户中当前可用的积分数量。

  • 每个API操作根据功能不同消耗特定数量的积分。
  • 可在您的账户仪表板购买额外积分。
Example:

100

⌘I