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

创建 Agent 会话

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

1. 接口描述

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

为指定 Agent 创建新的会话,返回会话 ID 和聊天凭证。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAgentSession。
Version String 公共参数,本接口取值:2026-07-09。
Region String 公共参数,本接口不需要传递此参数。
AgentId String

Agent 业务 ID


示例值:01M2YYX05YE46QG88E1SEPMZ9J
VersionId String

指定版本 ID(可选)。非空且合法时固定使用该版本,跳过 routing_config 权重挑选;指定版本需归属同一 Agent 且未被废弃


示例值:2101589342229893121

3. 输出参数

参数名称 类型 描述
SessionId String

会话 ID


示例值:2101973232405491712
EndpointSet Array of ChatEndpoint

可用的聊天接入点列表(当前仅含一个 PUBLIC 公网接入点;空数组 = 无可用接入点)

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建 Agent 会话

输入示例

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

{
    "AgentId": "736918300000000001",
    "VersionId": "2087791755109965825"
}

输出示例

{
    "Response": {
        "SessionId": "sess-9f3c1a2b7d4e",
        "EndpointSet": [
            {
                "EndpointType": "PUBLIC",
                "Url": "https://736918300000000001-tc-nanjing.example-workbuddy.com"
            }
        ],
        "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。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.IdentityNotFound AuthFailure.IdentityNotFound
AuthFailure.IdentityResolutionFailed AuthFailure.IdentityResolutionFailed
FailedOperation.AgentNoRoutingConfig FailedOperation.AgentNoRoutingConfig
FailedOperation.EntitlementNotFound FailedOperation.EntitlementNotFound
InternalError.EntitlementCheckFailed InternalError.EntitlementCheckFailed
InternalError.MarshalFailed InternalError.MarshalFailed
InternalError.NoResolver InternalError.NoResolver
InternalError.Panic InternalError.Panic
InternalError.ReadBodyFailed InternalError.ReadBodyFailed
InternalError.ResolveEnterpriseFailed InternalError.ResolveEnterpriseFailed
InternalError.RuntimeCreateFailed InternalError.RuntimeCreateFailed
InternalError.SessionOperationFailed InternalError.SessionOperationFailed
InternalError.TenantResolveFailed InternalError.TenantResolveFailed
InternalError.Unknown InternalError.Unknown
InvalidParameter.ActionNotFound InvalidParameter.ActionNotFound
InvalidParameter.ActionRequired InvalidParameter.ActionRequired
InvalidParameter.AgentIDRequired InvalidParameter.AgentIDRequired
InvalidParameter.AgentNoPublishedVersion InvalidParameter.AgentNoPublishedVersion
InvalidParameter.EmptyBody InvalidParameter.EmptyBody
InvalidParameter.InvalidJSON InvalidParameter.InvalidJSON
InvalidParameter.InvalidRequestBody InvalidParameter.InvalidRequestBody
MissingParameter.UinRequired MissingParameter.UinRequired
ResourceNotFound.Agent ResourceNotFound.Agent
ResourceUnavailable.ChatTokenUnavailable ResourceUnavailable.ChatTokenUnavailable
ResourceUnavailable.RuntimeAPIUnavailable ResourceUnavailable.RuntimeAPIUnavailable
UnauthorizedOperation.UnprovisionedTenant UnauthorizedOperation.UnprovisionedTenant