跳转到主要内容
GET
查询用户余额

查询用户余额

实时查询你的用户账户当前积分余额。

使用场景

控制台展示

在你的应用控制台中展示实时账户余额

余额提醒

积分低于阈值时发送通知

充值提醒

在积分用完前提示用户充值

用量追踪

监控积分消耗并追踪消费模式

重要说明

实时余额:返回的余额反映请求时刻的当前积分数量。
频率控制:避免过度轮询。缓存余额,仅在必要时刷新(例如完成一个生成任务之后)。

授权

Authorization
string
header
必填

所有 API 接口都需要 Bearer Token 认证。

创建 API Key:登录 PoYo,进入 仪表盘 → API 密钥(poyo.ai/zh/dashboard/api-key),点击创建 Key。

在请求头中添加:

响应

余额获取成功

code
enum<integer>
必填

业务状态码。200 表示成功,其他值都表示请求失败。请务必检查这个字段:部分参数校验错误会以 HTTP 200 返回,响应体里的 code 为 400。

  • 200:成功
  • 400:请求参数无效
  • 401:API Key 缺失或无效
  • 402:积分不足
  • 403:没有权限
  • 404:资源不存在
  • 408:请求超时
  • 429:请求频率超限
  • 500:服务器内部错误
  • 502:上游服务错误
  • 503:服务暂不可用

详见错误码。

可用选项:
200,
400,
401,
402,
403,
404,
408,
429,
500,
502,
503
示例:

200

data
object
必填