delete_session-删除会话--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

请输入

会话 (Sessions)

delete_session-删除会话

概述

/api/v1/sessions/{id} 接口用于删除指定会话。
删除后，该会话对应的会话数据将不再出现在会话列表中。该接口适用于业务侧会话清理、测试数据回收以及无效会话移除。

前置条件

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

请求接口

URI

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

请求方法

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

请求头

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

请求参数

参数	类型	位置	必选	默认值	备注
id	string	Path	是	--	要删除的会话 ID

响应消息

字段	参数说明
status	请求状态，成功为 `"ok"`，失败为 `"error"`
result	成功时返回的数据对象
result.session_id	已删除的会话 ID
error	失败时返回的错误对象
error.code	错误码字符串
error.message	可读的错误描述

常见错误码

error.code	说明
UNAUTHENTICATED	缺少 API Key 或 API Key 无效
PERMISSION_DENIED	API Key 权限不足
NOT_FOUND	指定会话不存在

完整示例

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

执行成功返回：

{
  "status": "ok",
  "result": {
    "session_id": "a1b2c3d4"
  }
}

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

概述 #

前置条件 #

请求接口 #

URI #

请求方法 #

请求头 #

请求参数 #

响应消息 #

常见错误码 #

完整示例 #

概述