Skip to main content
GET
查询当前 AIBase-API-Key 对应账号的剩余积分(points)与各项 API 权限的额度使用情况(permissions),用于在批量调用前确认配额、或在自动化流程中做额度水位监控。
执行模式:SYNC · 同步,且不走统一任务入口。 本接口是独立的 GET 端点:不使用 POST /v1/openapi/tasks,也不需要传 apiCode,服务端在当前 HTTP 响应中直接返回结果,无需轮询任务状态。

接口速查

调用前需要完成两项准备:创建 API Key、仅在服务端读取密钥。

请求头

string
required
AIBase 开放平台 API Key,例如 AIBase_xxx。请仅在服务端保存和使用。
string
可选的客户端请求标识。建议为每次调用生成唯一值,方便排查链路问题。

请求参数

本接口为 GET 请求,无请求体,也无需传递任何 Query 参数。账号身份完全由请求头 AIBase-API-Key 决定,因此不同 API Key 查询到的是各自账号的额度数据。

成功响应

integer
required
业务状态码。200 表示查询成功。
string
required
响应说明,如 成功
object
required
额度业务数据。注意:本接口的 data 直接就是额度对象,不存在 data.result 层级。
integer
required
当前账号剩余积分。
object[]
required
当前账号可用的权限及额度使用情况列表。无权限时可能为空数组。
string
required
权限或 API 能力的唯一编码,例如 GEO_AI_QUESTIONS
string
required
权限或 API 能力名称,例如 AI对话问题挖掘
string[] | null
required
该权限支持或关联的大模型平台编码列表;不适用时为 null
integer | null
required
当前周期内总可用次数;无限制或不适用时为 null
integer | null
required
当前周期已使用次数;不适用时为 null
integer | null
required
当前周期剩余可用次数;不适用时为 null
integer
required
服务端响应时间戳,单位为毫秒。
官方文档未给出本接口的错误响应样例。上例仅用于说明失败时的结构:code200datanull;具体 codemsg 文案以实际返回为准,客户端应统一按「非 200 即失败」处理,不要依赖固定文案做分支判断。

权限编码对照(参考)

下表由权限名称与已开放业务接口整理得出,官方接口文档未声明该映射关系,不作为接口契约依据,实际以控制台显示为准。
GEO_RANK_MONITOR_EXPORT_DATA(导出数据)、GEO_RANK_MONITOR_REPORT_GENERATION(生成报告)、PROMPTION_NEWSDEDICATED_CUSTOMER_SERVICE 属于平台侧功能权益,与开放 API 的 apiCode 无对应关系。

类型定义

完整响应类型为 AIBaseResponse<QuotaUsageData>。三个计数字段需使用包装类型 Integer 以兼容 null

接入注意事项

  1. 请求方式固定为 GET,接口地址固定为 https://api.aibase.cn/v1/openapi/quota/usage
  2. 本接口无需 apiCode,也无需请求体,不要按统一任务入口的格式提交。
  3. AIBase-API-Key 必须通过请求头传递,不要拼接在 URL 查询串中。
  4. 先判断外层 code 是否为 200,成功后再读取 data;失败时 data 可能为 null
  5. data 下没有 result 层级pointspermissions 直接位于 data 之下。
  6. permissions[].totalLimitusedCountremainingCount 以及 aiPlatforms 都可能为 null(表示无限制或不适用),客户端必须做空值兼容,不要用 0 兜底参与额度判断。
  7. permissions 可能为空数组,遍历前先判空。
  8. API Key 属于敏感凭证,应仅在服务端使用,避免在前端或日志中暴露查询结果。
批量跑批前先调用本接口核对 remainingCount,可在提交前规避配额耗尽导致的失败;出现异常时按联调排错清单逐项检查。