1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
创建会话。
为指定 Agent 和用户创建会话,创建成功后返回会话信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateSession。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai 。 |
| SpaceId | 是 | String | 会话所属空间 ID。 示例值:space-75f28517-9fb3-4234-9530-afa323f496bc |
| UserId | 是 | String | 用户 ID。可通过调用方业务系统接口获取。 示例值:0001 |
| SessionId | 否 | String | 会话 ID。可通过 CreateSession 或 DescribeSessions 接口获取。 示例值:session-order-assistance-20260817-0001 |
| Title | 否 | String | 会话标题,最大长度 256 字符。 示例值:0902 test |
| State | 否 | SessionState | 初始会话状态。 |
| Metadata.N | 否 | Array of MetadataVar | 创建会话时设置的初始元数据,以键值对数组形式表示。每个元素包含 Metadata 名称和对应值。 入参限制:本参数可选,最多支持 64 项。Name 不能为空或重复,最大长度为 253 字节;Value 最大长度为 1024 字节,允许为空字符串。Metadata 序列化后的总大小不能超过 64 KiB。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Session | SessionInfo | 会话信息。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建session
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSession
<公共请求参数>
{
"SpaceId": "space-75f28517-9fb3-4234-9530-afa323f496bc",
"UserId": "0001",
"Title": "0902 test"
}
输出示例
{
"Response": {
"Session": {
"CreateTime": "2026-09-02T08:00:03Z",
"EventCount": 0,
"SessionId": "ffa6e867-a315-447e-917b-ba01ea557c02",
"SpaceId": "space-75f28517-9fb3-4234-9530-afa323f496bc",
"Title": "0902 test",
"UpdateTime": "2026-09-02T08:00:03Z",
"UserId": "0001"
},
"RequestId": "604abedd-3dfe-4d3d-a842-addbe6e28053"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.InternalError | InternalError.InternalError |
| InvalidParameter.InvalidParameter | InvalidParameter.InvalidParameter |
| InvalidParameter.SessionIdDuplicate | InvalidParameter.SessionIdDuplicate |
| MissingParameter.MissingParameter | MissingParameter.MissingParameter |
| ResourceNotFound.SessionSpaceNotExist | 指定的会话空间不存在,或不属于当前应用及地域。 |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |