list_sessions-列出会话--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

请输入

会话 (Sessions)

list_sessions-列出会话

概述

/api/v1/sessions 接口用于列出当前用户在指定 Agent 作用域下的所有会话。
该接口通常用于会话管理页面初始化、历史会话列表展示，以及业务系统按会话维度做检索、追踪或删除操作前的查询。

前置条件

完成 API 鉴权说明页面的 API Key 获取后，可调用本接口列出会话。

请求接口

URI

/api/v1/sessions
统一资源标识符。

请求方法

GET
客户端对服务器请求的操作类型。

请求头

参数	值	说明
Authorization	`Bearer {api_key}`	鉴权
X-OpenViking-Agent	`{agent_id}`	Agent ID

请求参数

无。

响应消息

字段	参数说明
status	请求状态，成功为 `"ok"`，失败为 `"error"`
result	成功时返回的会话列表
result[].session_id	会话 ID
result[].uri	会话对应的 Viking URI
result[].is_dir	是否为目录型节点，固定为 `true`
error	失败时返回的错误对象
error.code	错误码字符串，常见值见下表
error.message	可读的错误描述

常见错误码

error.code	说明
UNAUTHENTICATED	缺少 API Key 或 API Key 无效
PERMISSION_DENIED	API Key 权限不足

完整示例

curl -X GET `https://xxx/api/v1/sessions` \
  -H "Authorization: Bearer {api_key}" \
  -H "X-OpenViking-Agent: {agent_id}"

执行成功返回：

{
  "status": "ok",
  "result": [
    {
      "session_id": "a1b2c3d4",
      "uri": "viking://session/alice/a1b2c3d4",
      "is_dir": true
    },
    {
      "session_id": "e5f6g7h8",
      "uri": "viking://session/alice/e5f6g7h8",
      "is_dir": true
    }
  ]
}

最近更新时间：2026.05.26 11:19:27

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

概述 #

前置条件 #

请求接口 #

URI #

请求方法 #

请求头 #

请求参数 #

响应消息 #

常见错误码 #

完整示例 #

概述