助手
TRAE 智能问答助手
你好,我是 TRAE 文档问答助手 🎉 你在阅读当前文档的过程中,无论对文档概念的解释,还是文档内容方面的疑问,都可以随时向我提问,我会全力为你解答
推荐问题
TRAE IDE 里最热门的 Skill 是哪些?
如何创建自定义智能体?
如何配置 Rules?
文档反馈

查询成员的个人用量限额

查询指定成员当前的用量限额,包括 TRAE 内置模型和企业内置模型的成员个人限额配置。

所需权限

quota:read

请求说明

  • 请求方式:POST
  • 请求地址:{域名}/openapi/v1/quota/query_user_usage_quota

请求体

参数说明

参数

类型

是否必填

描述

emails string[] 条件必填 待查询用量限额的成员的邮箱。与 user_ids 至少传入一个。邮箱不区分大小写。

user_ids

string[]

条件必填

待查询用量限额的成员的用户 ID。与 emails 至少传入一个。

你需要调用 “获取成员列表” 接口来获取成员的用户 ID,详情参考获取成员列表

提示

单次请求支持同时传入 emailsuser_ids。系统会根据邮箱或用户 ID 解析成员,并对重复成员自动去重。去重后,单次请求最多支持传入 50 个成员。

响应参数

该 OpenAPI 特有的响应参数如下:

参数

类型

描述

trae_model_quota_type

string

企业当前对 TRAE 内置模型采用的用量计算模式。取值:

  • token :按 Token 计,仅旧企业版套餐使用。
  • price:按金额计(单位:元),仅新企业版套餐使用。
pooling_enabled bool 企业当前是否已启用 “共享额度池(池化)” 功能。该功能仅对新旗舰版套餐和 TRAE 内置模型生效。详情参考共享额度池

quota_granularity

string

企业当前的额度配置粒度。取值:

  • all:为全部模型设置一个总额度。
  • per_model:为每个模型单独设置额度。
users array 已查询到的成员用量限额信息。具体字段说明参考设置成员的用量限额
not_found_users string[] 未查询到或不属于当前企业的成员标识。

请求示例

{
  "emails": ["john@example.com"],
  "user_ids": ["12345"]
}

响应示例

{
  "code": 0,
  "message": "success",
  "request_id": "req_abc123xyz",
  "data": {
    "trae_model_quota_type": "price",
    "pooling_enabled": true,
    "quota_granularity": "all",
    "users": [
      {
        "email": "john@example.com",
        "user_id": "12345",
        "basic_quota": 20,
        "total_excess_quota": 5000,
        "trae_model_excess_quota": [],
        "custom_model_excess_quota": [
          {
            "name": "Enterprise-GPT",
            "token_quota": 10000000
          }
        ]
      }
    ],
    "not_found_users": ["unknown@example.com"]
  }
}

错误码

关于该 OpenAPI 可能返回的错误码,参考错误码