帮你快速理解、总结文档立即下载

数据结构

最近更新时间:2026-09-23 04:25:00
我的收藏

A2AConfig

Agent 的 A2A 对外互通配置与注册态

被如下接口引用:CreateAgent, DescribeAgent, ModifyAgent, ModifyAgentA2AConfig, ModifyAgentRouting。

名称 类型 必选 描述
A2AEnabled Boolean Agent 级唯一 A2A 开关
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
A2APublicRef String 对外 A2A handle(已注册时;仅 DescribeAgent / ModifyAgentA2AConfig 填充)
注意:此字段可能返回 null,表示取不到有效值。
示例值:agents/data-analyst
A2AEndpoint String 对外 A2A card 发现地址(已注册时)
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://a2a.example.com/agents/data-analyst
A2AStatus String 注册状态:DRAFT / REGISTERED / DISABLED / NONE / UNKNOWN
注意:此字段可能返回 null,表示取不到有效值。
示例值:ACTIVE

A2ASkillInput

A2A skill 录入项(注册外部 Agent 时传入)

被如下接口引用:ModifyAgentA2AConfig。

名称 类型 必选 描述
A2ASkillId String

A2A skill ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:order_query
Name String

skill 名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:订单查询
Description String

skill 描述


注意:此字段可能返回 null,表示取不到有效值。
示例值:可以查询订单
Tags Array of String

标签


注意:此字段可能返回 null,表示取不到有效值。
示例值:["订单"]
Examples Array of String

示例


注意:此字段可能返回 null,表示取不到有效值。
示例值:["查一下上周订单"]

A2ASkillItem

A2A skill 列表项(出参用,来自 A2A card 解析结果)

被如下接口引用:DescribeExternalAgent, DescribeExternalAgentList。

名称 类型 必选 描述
A2ASkillId String A2A skill ID(加 A2A 前缀与内部 SkillId 概念区分)
注意:此字段可能返回 null,表示取不到有效值。
示例值:skill-7f8g9h
Name String skill 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:数据分析
Description String skill 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:负责数据查询与分析技能

AgentItem

Agent 列表项(原 AgentSummary;Agent 级纯字段,不再内嵌版本信息)

被如下接口引用:DescribeAgentList。

名称 类型 必选 描述
AgentId String Agent 业务 ID(全局唯一,数字字符串形态)
注意:此字段可能返回 null,表示取不到有效值。
示例值:736918300000000001
AgentName String Agent 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:数据分析助手
Description String Agent 描述;未填写时缺省
注意:此字段可能返回 null,表示取不到有效值。
示例值:负责每日运营数据的汇总与分析
AvatarUrl String 头像 URL;未设置时缺省
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://example.com/avatar/agent-001.png
CreatedTime String 创建时间,RFC3339 UTC 格式(如 2026-06-01T09:00:00Z)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-06-01T09:00:00Z
ModifiedTime String 更新时间,RFC3339 UTC 格式(如 2026-09-10T15:20:00Z)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-09-10T15:20:00Z
A2AEnabled Boolean Agent 级 A2A 开关。false 恒输出(未开启不等于字段缺失);A2AEndpoint / A2AStatus 由本接口在 A2A 开启时直接下发
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
SessionCount Integer 历史会话总数(t_managed_agent_sessions 未软删计数,含全部状态)。注意与 DescribeAgent.ActiveSessionCount(活跃会话数)口径不同
注意:此字段可能返回 null,表示取不到有效值。
示例值:42
Model String 最新版本的模型标识,取 latest_version_id 指向版本的 model;Agent 尚无版本时缺省
注意:此字段可能返回 null,表示取不到有效值。
示例值:hunyuan-turbos-latest
LatestVersionId String 最新版本 ID(latest_version_id 转字符串,19 位雪花数字形态);Agent 尚无版本时缺省
注意:此字段可能返回 null,表示取不到有效值。
示例值:2087791755109965825
LatestVersionName String 最新版本名(可能为 default / test-N / prod-N 任意类型);Agent 尚无版本时缺省
注意:此字段可能返回 null,表示取不到有效值。
示例值:prod-3
A2AEndpoint String 对外 A2A card 发现地址(Agent Card JSON 地址),仅 A2AEnabled=true 的行下发;未注册 / registry 读失败时缺省
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://a2a.example.workbuddy.com/agents/736918300000000001/.well-known/agent-card.json
A2AStatus String A2A 注册态:DRAFT / REGISTERED / DISABLED / NONE / UNKNOWN,仅 A2AEnabled=true 的行下发,与 DescribeAgent.A2AConfig.A2AStatus 同枚举;用于「开关已开但地址尚未生成」的空态文案
注意:此字段可能返回 null,表示取不到有效值。
示例值:REGISTERED
PublicApiEnabled Boolean 公网链接访问开关。false 恒输出(未开启不等于字段缺失)
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
PublicApiUrl String 公网访问地址,仅 PublicApiEnabled=true 的行下发。固定拼法 https://{AgentId}-{region}.{endpoint_suffix},与 DescribeAgentPublicAccess.Url 同规则;endpoint_suffix 未配置时为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://736918300000000001-tc-nanjing.example-workbuddy.com
CreatorUin String 创建人 UIN(建号时落库的 sub_account_uin;主账号自建时为主账号 uin)。注意语义为「实际操作建号的账号」
注意:此字段可能返回 null,表示取不到有效值。
示例值:100012345678
AccountId String 绑定的 OneID 企业账号 ID(数字字符串形态,如 1438693592234206274);空=未绑定(缺省)。与 DescribeAgent.AgentInfo.AccountId 同源同语义;创建时可选传入,之后不可变
注意:此字段可能返回 null,表示取不到有效值。
示例值:1438693592234206274

AgentVersionItem

Agent 版本列表项(原 AgentVersionSummary / AgentVersionBrief 合并,字段取并集)

被如下接口引用:DescribeAgentVersionList。

名称 类型 必选 描述
VersionId String 版本 ID(雪花算法生成的数字字符串,唯一标识)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2101589342229893121
VersionName String 版本名称,形如 default / test-N / prod-N(N 为同类型版本的自增序号)
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
VersionType String 版本类型(服务端按 VersionName 派生):DEFAULT(默认版本,可编辑)/ TEST(测试版本,可编辑)/ PROD(生产版本,内容冻结)
注意:此字段可能返回 null,表示取不到有效值。
示例值:DEFAULT
Model String 版本绑定的模型标识;未设置时缺省
注意:此字段可能返回 null,表示取不到有效值。
示例值:glm-5.2
SandboxTemplateId String 版本运行时使用的沙箱模板业务 ID;空字符串表示使用默认沙箱
注意:此字段可能返回 null,表示取不到有效值。
示例值:tpl-fxuctus69mgw
Status String 版本状态:DRAFT(草稿)/ ENABLED(已启用)/ DISABLED(已停用)
注意:此字段可能返回 null,表示取不到有效值。
示例值:ENABLED
SessionCount Integer

该版本累计承接的会话总数(历史累计值,只增不减)


注意:此字段可能返回 null,表示取不到有效值。
示例值:6
CreatedTime String 创建时间,RFC3339 UTC 格式(如 2026-08-01T10:00:00Z)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2006-01-02T15:04:05Z07:00
ModifiedTime String 更新时间,RFC3339 UTC 格式(如 2026-08-10T15:30:00Z)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2006-01-02T15:04:05Z07:00

BuiltinModel

内置模型信息

被如下接口引用:DescribeBuiltinModelList。

名称 类型 必选 描述
ModelId String 模型唯一标识
示例值:hunyuan-turbos-latest
Name String 模型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:混元 Turbos
Vendor String 供应商,如 TENCENT、OPENAI、ANTHROPIC、DEEPSEEK 等
注意:此字段可能返回 null,表示取不到有效值。
示例值:TENCENT
MaxOutputTokens Integer 最大输出 Token 数
注意:此字段可能返回 null,表示取不到有效值。
示例值:32768
MaxInputTokens Integer 最大输入 Token 数
注意:此字段可能返回 null,表示取不到有效值。
示例值:262144
SupportsToolCall Boolean 是否支持函数调用(Tool Call)
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
SupportsImages Boolean 是否支持视觉(图片输入)
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
DescriptionZh String 模型中文描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:混元 Turbo 版模型,速度快、成本低
DescriptionEn String 模型英文描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:Hunyuan Turbo model with fast speed and low cost
Tags Array of String 模型标签列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["chat", "tool_call"]
Clients Array of String 支持的客户端列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["web", "desktop"]
ServiceEndpoint String 服务接入地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://hunyuan.tencentcloudapi.woa.com
Status String 状态:ENABLED(已启用)/ DISABLED(已停用)
注意:此字段可能返回 null,表示取不到有效值。
示例值:ACTIVE
AgentCount Integer 本企业内绑定该模型的 Agent 数(过滤软删除 Agent/版本与调试 Agent)
注意:此字段可能返回 null,表示取不到有效值。
示例值:128

ChatEndpoint

聊天接入点。EndpointType 现在就引入枚举:当前仅返回一个 PUBLIC 元素,将来新增私网端点与 VPC 属性为纯增量。

被如下接口引用:CreateAgentSession, DescribeAgentSession。

名称 类型 必选 描述
EndpointType String 接入点类型:PUBLIC(公网)/ PRIVATE(私网,预留)
注意:此字段可能返回 null,表示取不到有效值。
示例值:WEB
Url String 接入点地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://example.com/chat/agent-001

ConnectorInfo

连接器详情(主表 + 最新版本展开)。

被如下接口引用:DescribeConnectorList。

名称 类型 必选 描述
ConnectorId String 连接器 ID
示例值:conn_a3b91f0e2d7c4f88
ConnectorSlug String 连接器短标识(终身不变,跨版本稳定)
示例值:notion-k3x9m2
ConnectorKey String 版本级连接器密钥
示例值:notion-k3x9m2-v2
Name String 连接器名称
示例值:notion
Description String 连接器描述
示例值:企业 Notion 接入
AvatarUrl String 头像 URL
示例值:https://example.com/icon.png
Source String 连接器来源:ENTERPRISE_AGENT / ASSISTANT
示例值:ENTERPRISE_AGENT
EnterpriseId String 归属企业 ID
示例值:ent-xxxx
Type String 连接器类型:MCP_SERVER / A2A / API_SERVICE
示例值:MCP_SERVER
ServiceUrl String 上游服务地址
示例值:https://mcp.notion.internal/v1
AuthModes Array of String 授权方式列表:NONE / ONEID / OAUTH2_IDP
示例值:["ONEID"]
LatestVersionNo Integer 最新版本号
示例值:2
Status String 连接器状态:ACTIVE / DISABLED
示例值:ACTIVE
CreatorId String 创建人 ID
示例值:100012345
CreatedTime String 创建时间(ISO8601,UTC)
示例值:2026-08-26T09:10:03Z
ModifiedTime String 最后修改时间(ISO8601,UTC)
示例值:2026-08-26T11:20:44Z

ConnectorRefInput

连接器引用入参

被如下接口引用:CreateAgent, ModifyAgentVersion。

名称 类型 必选 描述
ConnectorId String connector 主表 ID(雪花 ID 数字串)
示例值:conn-p1q2r3

ExpertCounts

全局专家计数

被如下接口引用:DescribeExpertList。

名称 类型 必选 描述
Builtin Integer

内置专家数


注意:此字段可能返回 null,表示取不到有效值。
示例值:323
Custom Integer

自建专家数


注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Total Integer

总数


注意:此字段可能返回 null,表示取不到有效值。
示例值:323

ExpertItem

专家列表/详情项

被如下接口引用:DescribeExpertList。

名称 类型 必选 描述
Source String

专家来源:builtin、custom


示例值:BUILTIN
DisplayName String

展示名


示例值:伯乐乐
Description String

描述


示例值:精通人才招聘全流程,为团队找到最佳人才
Icon String

图标 URL


示例值:https://staging-download.codebuddy.cn/public/experts/avatars/ZhihuStrategist.png
Enabled Boolean

是否启用


示例值:true
DownloadUrl String

下载 URL


示例值:https://staging-download.codebuddy.cn/operation-platform/experts/plugins/content-platform-experts/1.0.0.zip?sign=1789570921-aa39d00c6366b112-0-7042175b3155a3b0d1a4621502c968af&expert_id=ex_T7onGXvlG7E7
ModifiedTime String

更新时间


示例值:2026-07-20T12:11:47Z
Status String

启停状态:enabled、disabled


示例值:ENABLED
ExpertId String

专家标识


注意:此字段可能返回 null,表示取不到有效值。
示例值:ex_McsoRGB85Aax
ExpertVersion String

当前生效版本号


注意:此字段可能返回 null,表示取不到有效值。
示例值:1.0.1

ExternalAgentInfo

外部 Agent 列表/详情项

被如下接口引用:DescribeExternalAgentList。

名称 类型 必选 描述
A2AAgentId String 外部 A2A agent ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:a2a-q7r8s9t0
Name String 外部 Agent 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:外部助手
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:一个用于外部协作的智能助手
Endpoint String 外部 A2A Server URL
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://example.com/a2a/agent
BindingId String 绑定记录 ID(已绑定时返回)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024
Bound Boolean 是否已绑定到当前 Agent
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
IconUrl String 头像地址(取自 provider card 的 iconUrl)
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://xxx.xx/
A2AVersion String 外部 agent card 声明的版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.0
A2ASkillSet Array of A2ASkillItem A2A card skills 集合
注意:此字段可能返回 null,表示取不到有效值。

Filter

云 API 通用过滤结构。多个 Filter 之间为 AND 关系;同一 Filter 内多个 Values 为 OR 关系。

被如下接口引用:DescribeAgentList, DescribeAgentSessionList, DescribeAgentVersionList, DescribeBuiltinModelList, DescribeConnectorList, DescribeExpertList, DescribeExternalAgentList, DescribeMessageEventList, DescribeSkillList。

名称 类型 必选 描述
Name String 过滤属性名
注意:此字段可能返回 null,表示取不到有效值。
示例值:TaskName
Values Array of String 过滤值列表(同一 Filter 内多个值为 OR 关系)
注意:此字段可能返回 null,表示取不到有效值。
示例值:["每日日报", "每周周报"]
ExactMatch Boolean 是否精确匹配,默认 false(模糊匹配)
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

MessageEvent

消息事件

被如下接口引用:DescribeMessageEventList。

名称 类型 必选 描述
Sequence Integer

序号


注意:此字段可能返回 null,表示取不到有效值。
示例值:29
EventType String

类型 USER/TOOL/ASSISTANT


注意:此字段可能返回 null,表示取不到有效值。
示例值:TOOL
OccurredAt String

发生时间 ISO8601


注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-09-22T03:31:06Z
Message MessageEventMessage

消息内容


注意:此字段可能返回 null,表示取不到有效值。
ToolCall MessageEventToolCall

工具调用


注意:此字段可能返回 null,表示取不到有效值。

MessageEventMessage

消息内容

被如下接口引用:DescribeMessageEventList。

名称 类型 必选 描述
Content String

文本内容


注意:此字段可能返回 null,表示取不到有效值。
示例值:随便使用个工具,查一下当前目录有多少文件
TokenUsage TokenUsage

Token用量


注意:此字段可能返回 null,表示取不到有效值。

MessageEventToolCall

工具调用

被如下接口引用:DescribeMessageEventList。

名称 类型 必选 描述
ToolCallId String

调用ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:call_f4b4a3c718354152a953c5de
ToolName String

工具名


注意:此字段可能返回 null,表示取不到有效值。
示例值:Bash
Status String

状态 PENDING/IN_PROGRESS/SUCCEEDED/FAILED


注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCEEDED
Input String

工具调用Input(已递归脱敏,JSON 字符串)


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"command":"ls -1 /workspace/2102239219915046912 | wc -l","description":"统计当前目录文件数量"}
Output String

工具调用Output(已递归脱敏,JSON 字符串)


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"text":"Command: ls -1 /workspace/2102239219915046912 | wc -l\nStdout: 0\n\nStderr: (empty)\nExit Code: 0\nSignal: (none)","type":"text"}
EndedAt String

结束时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-09-22T03:31:10Z
DurationMs Integer

耗时毫秒


注意:此字段可能返回 null,表示取不到有效值。
示例值:100
StartedAt String

调用开始时间(RFC3339 格式)


注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-09-22T03:31:10Z

RoutingItem

路由项

被如下接口引用:CreateAgent, DescribeAgent, ModifyAgent, ModifyAgentA2AConfig, ModifyAgentRouting。

名称 类型 必选 描述
VersionId String 版本 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:v12
Weight Float 权重,(0, 1] 之间的浮点百分比
注意:此字段可能返回 null,表示取不到有效值。
示例值:100

SessionItem

会话列表项

被如下接口引用:DescribeAgentSessionList。

名称 类型 必选 描述
SessionId String 会话 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:sess_a1b2c3d4
SessionName String 会话名称(AI 生成标题或用户改名;缺失时为空)
注意:此字段可能返回 null,表示取不到有效值。
示例值:每日日报
AgentId String Agent 业务 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:736918300000000001
AgentName String Agent 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:数据分析助手
VersionName String 会话使用的版本名称(与 VersionId 区分:此为版本名,非 ID;原 AgentVersion)
注意:此字段可能返回 null,表示取不到有效值。
示例值:v12
VersionId String 会话使用的 Agent 版本 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:v12
Status String 会话状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMPLETED
Creator String 创建者 Uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:100012345678
Source String 会话来源
注意:此字段可能返回 null,表示取不到有效值。
示例值:WEB
CreatedTime String 创建时间(RFC3339)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-09-18 10:00:00
ModifiedTime String 更新时间(RFC3339)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-09-18 10:30:00

SkillCounts

全局技能计数

被如下接口引用:DescribeSkillList。

名称 类型 必选 描述
Builtin Integer 内置技能数
注意:此字段可能返回 null,表示取不到有效值。
示例值:8
Custom Integer 自建技能数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
Total Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:13

SkillItem

Skill 列表项(按列表页展示裁剪:名称/版本/描述/状态/操作五列 + 编排所需的 Source 与 DownloadUrl)

被如下接口引用:DescribeSkillList。

名称 类型 必选 描述
Source String 技能来源:BUILTIN(内置)/ CUSTOM(自建)/ AUTHORIZED(企业授权)
示例值:authorized
Name String

slug(仅 custom 返回)


示例值:tst
DisplayName String

展示名


示例值:t
Description String

描述


示例值:t
Icon String

图标 URL


示例值:t
Enabled Boolean

是否启用


示例值:true
DownloadUrl String

下载 URL


示例值:d
SkillId String

技能标识


示例值:skill-7f8g9h
SkillVersion String

当前生效版本号


注意:此字段可能返回 null,表示取不到有效值。
示例值:v1.2.0
CreateTime String 创建时间,RFC3339 UTC 格式(如 2026-08-11T09:23:10Z)
示例值:2026-08-11T09:23:10Z
UpdateTime String 更新时间,RFC3339 UTC 格式(如 2026-09-15T06:51:26Z)
示例值:2026-09-15T06:51:26Z

TokenUsage

Token用量

被如下接口引用:DescribeMessageEventList。

名称 类型 必选 描述
InputTokens Integer

输入Token


注意:此字段可能返回 null,表示取不到有效值。
示例值:19143
OutputTokens Integer

输出Token


注意:此字段可能返回 null,表示取不到有效值。
示例值:42
TotalTokens Integer

总Token


注意:此字段可能返回 null,表示取不到有效值。
示例值:19185
Scope String

统计口径


注意:此字段可能返回 null,表示取不到有效值。
示例值:TURN