Skip to content

Credits 模块(积分)

Credits 模块提供底层积分操作能力。

API 列表

方法返回值说明
sdk.credits.getBalance()Promise<{ quota: number }>查询积分余额(网络请求)
sdk.credits.getCachedBalance()number获取缓存余额(同步,首次调用前为 0)
sdk.credits.onChange(callback)() => void监听积分变化

详细用法

查询余额

typescript
const { quota } = await sdk.credits.getBalance()
console.log('积分余额:', quota)

// 同步获取上次查询的缓存值
const cached = sdk.credits.getCachedBalance()

WARNING

返回字段名是 quota(对应后端 /ai/v1/credit/getBalance 接口的返回结构),不是 balance

监听变化

typescript
const unsubscribe = sdk.credits.onChange((balance) => {
  updateCreditsDisplay(balance)
})

unsubscribe() // 取消监听

Billing vs Credits

模块定位适用场景
credits底层积分操作需要直接查询/扣除积分的场景(如 AI 生成等自定义 action)
billing高层统一计费导出、下载等标准操作,自动处理免费次数→积分的降级逻辑

大多数场景推荐使用 billing 模块。

MIT Licensed