所需权限

所需权限	资源	Scope	资源服务
限额与计量读取（读取）	quota	admin.v1.quota.read	qwenwork-biz-service

GET /api/openapi/v1/quota-balance

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope；读取、管理与执行权限互不包含。

名称	位置	类型	必填	说明	示例
Authorization	header	string	是	应用 API Key，使用 Bearer 方式传递。	Bearer qwk_\\*
X-Request-Id	header	string	否	可选的调用追踪标识；未传入时由服务端生成。	req-20260831-001

请求参数

此接口没有额外请求参数。

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址，并填写实际参数。示例中的占位值不能直接用于请求。

curl --request GET --url '<BASE_URL>/api/openapi/v1/quota-balance' --header 'Authorization: Bearer <API_KEY>'

响应

200 请求成功，返回当前或更新后的数据。

名称	类型	必填	说明	示例
data_as_of	string · date-time	是	本次数据对应的时间，用于判断数据的新鲜程度。	"2026-08-27T10:00:00Z"
data_status	string	是	数据状态：fresh 为新鲜数据，stale 表示返回了旧数据。	"fresh"
period_ends_at	string · date-time	是	当前订阅周期的结束时间。	"2026-08-27T10:00:00Z"
remaining_quota	integer · int64	是	组织共享额度池的剩余积分，计算结果最低为 0。	0
total_quota	integer · int64	是	组织共享额度池的积分总量。	0
unit	string	是	额度的计量单位，credit 表示积分。	"credit"
updated_at	string · date-time	是	此记录最后一次更新的时间。	"2026-08-27T10:00:00Z"
used_quota	integer · int64	是	组织共享额度池中已使用的积分。	0

{
  "data_as_of": "2026-08-27T10:00:00Z",
  "data_status": "fresh",
  "period_ends_at": "2026-08-27T10:00:00Z",
  "remaining_quota": 0,
  "total_quota": 0,
  "unit": "credit",
  "updated_at": "2026-08-27T10:00:00Z",
  "used_quota": 0
}

default 请求失败，返回错误码和错误详情。

名称	类型	必填	说明	示例
code	string	否	用于程序判断错误原因的稳定业务错误码。	"<string>"
detail	string	是	便于阅读的错误说明。	"<string>"
details	OpenapiErrorDetails	否	字段校验失败时的详细信息。	{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.field	string	否	未通过校验的请求字段。	"<string>"
details.reason	string	否	稳定的校验失败原因，用于判断字段为何不合法。	"<string>"
details.suggestion	string	否	建议采用的规范化字段值。	"<string>"
error	string	是	稳定的 HTTP 错误类型。	"<string>"

{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}