commit_session-提交会话--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

请输入

会话 (Sessions)

commit_session-提交会话

概述

/api/v1/sessions/{id}/commit 接口用于提交会话。
提交后，系统会先完成消息归档（Phase 1），随后在后台异步执行摘要生成与记忆提取（Phase 2）。因此，该接口是把会话消息正式沉淀为长期上下文的关键步骤。

前置条件

完成 API 鉴权说明页面的 API Key 获取后，可调用本接口提交会话。通常你需要先向该会话写入至少一条消息。

请求接口

URI

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

请求方法

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

请求头

参数	值	说明
Content-Type	`application/json`	请求消息类型
Authorization	`Bearer {api_key}`	鉴权
X-OpenViking-Agent	`{agent_id}`	Agent ID

请求参数

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

请求体可为空 JSON：{}。

响应消息

字段	参数说明
status	请求状态，成功为 `"ok"`，失败为 `"error"`
result	成功时返回的数据对象
result.task_id	后台任务 ID，可用于轮询进度
result.status	任务受理状态，通常为 `accepted`
result.trace_id	本次处理的追踪 ID
result.archive_uri	本次归档生成的归档 URI
result.archived	是否已完成 Phase 1 归档
error	失败时返回的错误对象
error.code	错误码字符串
error.message	可读的错误描述

常见错误码

error.code	说明
UNAUTHENTICATED	缺少 API Key 或 API Key 无效
PERMISSION_DENIED	API Key 权限不足
NOT_FOUND	指定会话不存在
PROCESSING_ERROR	会话归档提交失败

完整示例

curl -X POST `https://xxx/api/v1/sessions/a1b2c3d4/commit` \
  -H "Authorization: Bearer {api_key}" \
  -H "X-OpenViking-Agent: {agent_id}" \
  -H "Content-Type: application/json" \
  -d '{}'

执行成功返回：

{
  "status": "ok",
  "result": {
    "task_id": "e3c0f5a2-89d8-4d4a-a6cf-2fd7f203c1e1",
    "status": "accepted",
    "trace_id": "trace_12345",
    "archive_uri": "viking://session/alice/a1b2c3d4/history/archive_003",
    "archived": true
  }
}

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

概述 #

前置条件 #

请求接口 #

URI #

请求方法 #

请求头 #

请求参数 #

响应消息 #

常见错误码 #

完整示例 #

概述