文档中心

向量数据库VikingDB

API 文档

API 文档概览

API 文档概览

API 文档概览

OpenViking 提供两类 API 接口，分别用于不同场景：

一、数据库访问

负责直接处理业务数据，包括会话管理、资源导入、文件内容读取、检索等操作。

鉴权方式

通过 API Key 鉴权，在 HTTP 请求头中携带 Authorization: Bearer {api_key}。

会话管理

接口能力	接口名称	功能说明
创建会话	create_session-创建会话	创建新的对话会话
添加消息	add_message-添加消息	向会话添加消息
获取会话	get_session-获取会话	获取会话详情
获取组装上下文	get_session_context-获取组装上下文	获取会话的组装上下文
列出会话	list_sessions-列出会话	获取会话列表
提交会话	commit_session-提交会话	提交会话
删除会话	delete_session-删除会话	删除会话

资源管理

接口能力	接口名称	功能说明
导入资源	add-resource-添加资源	向 OpenViking 导入资源
上传本地文件	temp_upload-上传本地文件	上传临时文件

文件内容操作

接口能力	接口名称	功能说明
读取摘要（L0）	abstract-读取摘要（L0）	读取文件摘要
读取概览（L1）	overview-读取概览（L1）	读取文件概览
读取完整内容（L2）	read-读取完整内容（L2）	读取文件完整内容
修改文件	write-修改文件	修改文件内容
重建索引	reindex-重建索引	重建文件索引

文件系统操作

接口能力	接口名称	功能说明
获取目录树结构	tree-获取目录树结构	获取目录树结构
列出目录内容	ls-列出目录内容	列出目录内容
创建目录	mkdir-创建目录	创建目录
移动资源	mv- 移动资源	移动资源
删除资源	rm-删除资源	删除资源
资源状态	stat-资源状态	获取资源状态

检索

接口能力	接口名称	功能说明
语义搜索	find-语义搜索	语义搜索
文件模式匹配	glob-文件模式匹配	文件模式匹配
模式搜索	grep-模式搜索	模式搜索
上下文感知搜索	search-上下文感知搜索	上下文感知搜索

技能管理

接口能力	接口名称	功能说明
导入技能	add_skill-导入技能	导入技能

任务管理

接口能力	接口名称	功能说明
获取后台任务状态	get_task-获取后台任务状态	获取任务状态
列出后台任务	list_tasks-列出后台任务	获取任务列表

二、数据库管理

负责资源管理与配置，包括用户管理等操作，管理数据所在的资源与元信息。

鉴权方式

通过火山引擎 AK/SK 签名鉴权，通过 TOP 开放网关调用。

用户管理

接口能力	接口名称	功能说明
库用户列表	list_users-库用户列表	查询库用户列表
获取库 API Key	get_user_access-获取库APIKey	获取库 API Key
注册库用户	register_user-注册库用户（企业版支持）	注册库用户（仅企业版支持）
删除库用户	delete_user-删除库用户（企业版支持）	删除库用户（仅企业版支持）

最近更新时间：2026.08.12 16:24:44

这个页面对您有帮助吗？

有用

有用

无用

无用