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

查询成员在各个模型中的用量

查询指定成员在各个模型中的 Token 用量和扣费金额。

所需权限

statistics:read

请求说明

  • 请求方式:POST
  • 请求地址:{域名}/openapi/v1/statistics/user-model-usage

请求体

参数

类型

是否必填

描述

start_time int64 查询开始时间,Unix 秒时间戳。
end_time int64 查询结束时间,Unix 秒时间戳,须不早于 start_time。时间跨度最多为 180 天。
emails string[] 条件必填 待查询用量的成员邮箱。与 user_ids 至少传入一个。邮箱不区分大小写。
user_ids string[] 条件必填 待查询用量的成员用户 ID。与 emails 至少传入一个。

提示

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

响应参数

该接口独有的响应参数如下,参数位于 data.items[] 中。通用响应参数参考此文档

参数

类型

描述

email string 成员的邮箱。
model_usage array 成员的用量信息,按模型汇总。
model_usage.model_name string 产生用量的模型名称。

model_usage.model_type

string

产生用量的模型能力类型,取值:

  • Chat:AI 问答
  • CUE:代码补全

model_usage.model_source

string

模型来源,取值:

  • Trae:TRAE 内置模型
  • Custom:企业自定义模型
model_usage.usage object Token 用量汇总信息。
model_usage.usage.input_tokens uint64 输入 Token 消耗总数。
model_usage.usage.output_tokens uint64 输出 Token 消耗总数。

model_usage.amount

object

折算后的实际扣费金额。

提示amount 对象中的参数仅统计 TRAE 内置模型(model_sourceTrae)的用量金额。

model_usage.amount.basic_amount string 折算后,所使用的基础会话额度对应的金额消耗。返回十进制金额字符串,固定保留 6 位小数,例如 1.500000
model_usage.amount.pay_go_amount string 折算后的按量计费消耗金额。返回十进制金额字符串,固定保留 6 位小数,例如 1.500000
model_usage.amount.total_amount string 折算后的总消耗金额,即 basic_amountpay_go_amount 之和。返回十进制金额字符串,固定保留 6 位小数,例如 1.500000

model_usage.amount.currency

string

扣费金额的币种,取值:

  • CNY:人民币
  • USD:美金

请求示例

curl -X POST "${HOST}/openapi/v1/statistics/user-model-usage" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": ["john@example.com"],
    "user_ids": ["123456789012345678"],
    "start_time": 1700000000,
    "end_time": 1700086400
  }'

响应示例

{
  "code": 0,
  "message": "success",
  "request_id": "021xxxxxxxxx",
  "data": {
    "items": [
      {
        "email": "john@example.com",
        "model_usage": [
          {
            "model_name": "Doubao-Seed-2.0-Code",
            "model_type": "Chat",
            "model_source": "Trae",
            "usage": {
              "input_tokens": 32312,
              "output_tokens": 7980090
            },
            "amount": {
              "basic_amount": "2.120000",
              "pay_go_amount": "23.220000",
              "total_amount": "25.340000",
              "currency": "CNY"
            }
          }
        ]
      }
    ]
  }
}