WorkBuddy Enterprise 查询 Agent 会话

1. 接口描述

接口请求域名： workbuddyenterprise.tencentcloudapi.com 。

查询单个 Agent 会话详情：返回会话基础信息（会话名称 / Agent / 版本 / 状态 / 来源 / 发起人）与可用的聊天接入点列表（EndpointSet）。数据面鉴权走 DescribeUserAccessToken 的用户级访问令牌。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAgentSession。
Version	是	String	公共参数，本接口取值：2026-07-09。
Region	否	String	公共参数，本接口不需要传递此参数。
SessionId	是	String	会话 ID 示例值：sess_a1b2c3d4

3. 输出参数

参数名称	类型	描述
SessionId	String	会话 ID 示例值：sess_a1b2c3d4
SessionName	String	会话名称（AgentOS 侧生成的 AI 标题 / 用户改名）；缺失时为空，调用方可兜底展示 SessionId 后缀示例值：每日日报
AgentId	String	Agent 业务 ID 示例值：736918300000000001
AgentName	String	Agent 名称示例值：数据分析助手
VersionId	String	版本 ID 示例值：v12
VersionName	String	会话使用的版本名称（与 VersionId 区分：此为版本名，非 ID）示例值：v12
Status	String	版本状态：DRAFT / ENABLED / DISABLED 示例值：ACTIVE
Creator	String	创建者 Uin 示例值：100012345678
Source	String	连接器来源：ENTERPRISE_AGENT / ASSISTANT 示例值：authorized
EndpointSet	Array of ChatEndpoint	可用的聊天接入点列表（详情独有）
CreatedTime	String	创建时间示例值：2026-09-18 10:00:00
ModifiedTime	String	更新时间（RFC3339）示例值：2026-09-18 10:00:00
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 Agent 会话详情

输入示例

POST / HTTP/1.1
Host: workbuddyenterprise.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentSession
<公共请求参数>

{
    "SessionId": "sess-9f3c1a2b7d4e"
}

输出示例

{
    "Response": {
        "SessionId": "sess-9f3c1a2b7d4e",
        "SessionName": "7 月运营数据汇总",
        "AgentId": "736918300000000001",
        "AgentName": "数据分析助手",
        "VersionId": "2087791755109965825",
        "VersionName": "prod-3",
        "Status": "ACTIVE",
        "Creator": "100012345678",
        "Source": "CLOUD",
        "EndpointSet": [
            {
                "EndpointType": "PUBLIC",
                "Url": "https://736918300000000001-tc-nanjing.example-workbuddy.com"
            }
        ],
        "CreatedTime": "2026-07-20T10:00:00Z",
        "ModifiedTime": "2026-07-20T10:35:00Z",
        "RequestId": "3c6d138e-1234-5678-9abc-def012345678"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询 Agent 会话详情

本页目录：