查询余额
查询当前 API Key 所属用户的余额状态。
docs-endpoint
1undefined| 字段 | 值 |
|---|---|
| Base URL | https://api.gate.ai |
| 认证 | Authorization: Bearer <API_KEY> |
| 格式 | Gate.AI REST JSON |
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Authorization | header | string | 是 | API Key 鉴权，格式：Bearer <API_KEY> |
返回字段说明
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | 业务状态码。成功固定为 200。 |
| data | object | 余额数据。 |
| data.status | integer | 余额状态：1 可交易，2 余额不足，4 已欠费。 |
| data.message | string | 状态描述。 |
| data.asset_type | string | 资产归属类型：user_asset 个人资产，organization_asset 组织资产。 |
| data.recharge_balance | string | 充值余额。 |
| data.debt_amount | string | 欠费金额；无欠费时为空字符串或 0 值字符串。 |
返回示例
json
1{2 "code": 200,3 "data": {4 "status": 1,5 "message": "可以交易",6 "asset_type": "user_asset",7 "recharge_balance": "12.34000000",8 "debt_amount": ""9 }10}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 查询成功，返回 code 和 data。 | CreditsBalanceResponse |
| 401 | Unauthorized | API Key 缺失、无效、过期、撤销、禁用或未激活。 | ErrorResponse |
| 403 | Forbidden | 当前 API Key 所属成员无权限查看余额。 | ErrorResponse |
| 429 | Too Many Requests | 触发限流。 | ErrorResponse |
| 500 | Internal Server Error | 网关内部错误，例如 API Key 查询异常或响应序列化失败。 | ErrorResponse |
| 502 | Bad Gateway | 余额上游服务不可用、返回非成功状态、响应解析失败或数据为空。 | ErrorResponse |
错误返回示例
json
1{2 "error": {3 "type": "authentication_error",4 "code": "7022002001",5 "message": "invalid api key"6 }7}