查询 Session 列表 - ListCoreSpaceSessions
功能介绍
该接口用于分页列出指定 Space 中的所有 Sessions,在需要查看或管理记忆空间下的会话列表、按 Actor 或 Session 维度筛选会话时使用。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
GET /v1/core/spaces/{space_id}/sessions
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| space_id | 是 | String | 参数解释: Space ID是记忆空间的唯一标识,可通过"创建Space"获取。 约束限制: 不涉及。 取值范围: UUID格式。示例:123e4567-e89b-12d3-a456-426614174001。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| actor_id | 否 | String | 参数解释: 按 Actor ID 过滤,仅返回指定 Actor 关联的记录。Actor ID 用于标识对话参与者。 约束限制: 不涉及。 取值范围: 长度1-64字符。 默认取值: 不涉及。 |
| session_id | 否 | String | 参数解释: 按 Session ID 过滤,支持逗号分隔多值(如 session_id=uuid1,uuid2),最多 100 个。 约束限制: 不涉及。 取值范围: 长度0-6500字符。 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 每页数量(单位:条),用于限制分页查询时每页返回的最大记录数。 约束限制: 不涉及。 取值范围: 1-100。 默认取值: 20。 |
| offset | 否 | Integer | 参数解释: 偏移量(单位:条),用于指定分页查询时的起始位置,从0开始计算。 约束限制: 不涉及。 取值范围: 0-2147483647。 默认取值: 0。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| items | Array of Session objects | 参数解释: 会话列表,包含当前页的所有会话记录。 取值范围: 0-100个。 |
| limit | Integer | 参数解释: 每页返回的记录数量(单位:条),用于分页查询。 取值范围: 1-100。 |
| offset | Integer | 参数解释: 偏移量(单位:条),用于分页查询时指定起始位置,从0开始。 取值范围: 0-2147483647。 |
| total | Integer | 参数解释: 符合条件的记录总数(单位:条),用于计算总页数。 取值范围: 0-2147483647。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: Session ID,唯一标识一个会话,可通过"创建Session"接口生成或由调用方指定。 取值范围: 长度1-64字符。 |
| space_id | String | 参数解释: 所属 Space ID,标识该记录所属的记忆空间,可通过"创建Space"接口获取。 取值范围: 长度36-36字符。 |
| actor_id | String | 参数解释: 归属 Actor ID,标识该记录所属的 Actor。 取值范围: 长度1-64字符。 |
| assistant_id | String | 参数解释: 归属 Assistant ID,标识该记录所属的 AI 助手。 取值范围: 长度1-64字符。 |
| meta | Object | 参数解释: 扩展元数据,用于存储自定义的附加信息,如标题、标签等。 取值范围: 不涉及。 |
| api_key | String | 参数解释: Session 访问API Key,仅在创建Session指定 enable_session_auth 为 true 时非空。 取值范围: 长度32-128字符。 |
| created_at | String | 参数解释: 记录的创建时间,由系统自动生成。 取值范围: 格式为 ISO 8601(YYYY-MM-DDTHH:mm:ssZ)。 |
| updated_at | String | 参数解释: 记录的最近更新时间,由系统自动更新。 取值范围: 格式为 ISO 8601(YYYY-MM-DDTHH:mm:ssZ)。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权失败信息。 取值范围: 长度1-4096字符。 |
| details | Array of Error objects | 参数解释: 依赖的下游服务错误信息列表,包含导致当前请求失败的下游服务错误详情。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权失败信息。 取值范围: 长度1-4096字符。 |
| details | Array of Error objects | 参数解释: 依赖的下游服务错误信息列表,包含导致当前请求失败的下游服务错误详情。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
请求示例
/v1/core/spaces/123e4567-e89b-12d3-a456-426614174000/sessions
响应示例
状态码:200
无
状态码:401
{
"error_code" : "AgentArts.01020002",
"error_msg" : "Authentication failed"
} 状态码:403
{
"error_code" : "AgentArts.01020003",
"error_msg" : "Insufficient permissions"
} 状态码:429
{
"error_code" : "AgentArts.01020008",
"error_msg" : "Too many requests"
} 状态码:500
{
"error_code" : "AgentArts.01020004",
"error_msg" : "Internal service error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功获取 Session 列表 |
| 401 | 认证失败 |
| 403 | 权限不足 |
| 429 | 请求过于频繁 |
| 500 | 内部服务错误 |
错误码
请参见错误码。