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

概览

TRAE 企业版 OpenAPI 为企业管理员提供了一套标准化的 HTTP 接口,用于在企业自有系统中集成 TRAE 的企业管理能力。

套餐要求

TRAE 企业版 OpenAPI 仅向订阅了旗舰版套餐的企业开放。

功能模块

目前 TRAE 企业版接口支持的功能如下:

模块 适用场景 能力
人员管理 将企业成员生命周期管理接入内部系统。 添加成员、邀请成员、查询成员列表、批量获取成员信息、更新成员信息、删除成员、重置成员账号密码。
部门管理 同步或维护企业组织架构。 创建部门、批量创建部门、查询部门信息、搜索部门、获取子部门、更新部门、批量删除部门。
数据分析 获取企业、成员或部门维度的 AI 与 MCP 使用概况。 查询活跃成员数、AI 使用数据、MCP 使用排行。
用量管理 查询用量明细与管理成员个人用量限额。 按成员或会话查询用量明细、查询模型用量、查询和设置成员个人用量限额。
日志管理 满足安全审计、问题排查和合规留痕要求。 查询 OpenAPI 调用日志、查询管理员操作日志。

调用流程

调用 TRAE 企业版接口的通用流程如下。详见鉴权

  1. 创建应用凭证:在 TRAE 企业版控制台中创建应用凭证,并为其配置所需的权限,从而获取相应的 app_idapp_secret
  2. 获取访问令牌:使用 app_idapp_secret 调用鉴权接口,获取 access_token
  3. 调用业务接口:在请求头中通过 Authorization: Bearer {access_token} 携带访问令牌,调用对应的业务接口。
  4. 解析响应:处理响应;遇到异常时,参考错误码进行排查与重试。

请求地址

所有接口的请求地址均由 Base URL 和接口路径两部分组成。

  • Base URL
    • 若你的企业未配置专属域名,统一使用 https://console.enterprise.trae.cn
    • 若你的企业已配置专属域名,使用该专属域名。
  • 接口路径:所有接口的路径均以 /openapi/v1/ 为前缀。

请求频率限制

为保障服务稳定性,API 调用存在频率限制。

读操作接口的调用频率默认不超过 5 QPS,写操作接口不超过 3 QPS。

当请求频率超过限制时,API 将返回 HTTP 429 和 code: 64290。同时,响应头会包含 Retry-After 字段。