文档中心

向量数据库VikingDB

请输入

文件内容（File Contents）

overview-读取概览（L1）

概述

/api/v1/content/overview 接口用于读取 OpenViking 文件系统中目录的 L1 概览，适用于目录。

前置条件

完成 "数据库访问使用说明" 页面的 API Key 获取后，可调用本接口读取概览。

请求接口

URI	/api/v1/content/overview	统一资源标识符
请求方法	GET	客户端请求类型
请求头	Authorization: Bearer	Bearer Token 鉴权

请求参数

参数	类型	必选	默认值	备注
uri	string	是	--	Viking URI 必须是目录 URI。

响应消息

字段	参数说明
status	请求状态，成功为 `"ok"`，失败为 `"error"`
result	成功时返回的概览文本（Markdown 格式）
telemetry	遥测信息，通常为 `null`
error	失败时返回的错误对象
error.code	错误码字符串，常见值见下表
error.message	可读的错误描述

常见错误码：

error.code	HTTP 状态码	说明
UNAUTHENTICATED	401	缺少或无效的 API Key
INVALID_ARGUMENT	400	无效参数，如 uri 不是目录
INVALID_URI	400	无效的 Viking URI 格式
NOT_FOUND	404	资源未找到

完整示例

示例一：读取目录概览

curl -X GET "https://xxx/api/v1/content/overview?uri=viking://resources/docs/" \
  -H "Authorization: Bearer your-key"

执行成功返回：

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "ok",
    "result": "# 咖啡点单页设计\n\n## Brief Description\nThis repository houses all resources related to the design and development of a coffee ordering page...",
    "error": null,
    "telemetry": null
}

参数、示例与排错补充

返回参数描述不完整：返回结构采用统一包装：status 为 string，result 为 object/array/null，telemetry 为 object/null，error 为 object/null；业务子字段的类型和层级与成功示例保持一致。
请求示例与请求参数说明不符：请求示例统一使用 Authorization: Bearer <API_KEY>，与请求头参数表保持一致。
标识型参数缺少获取规则：uri 使用 viking://<namespace>/<path> 格式；从创建/导入资源响应的 result.uri，或 ls、tree、find、grep 的结果中复制。
错误码原因或处理建议缺失：错误处理建议：UNAUTHENTICATED：检查并重新生成 API Key；PERMISSION_DENIED：确认 Agent/账号对目标 URI 有权限；INVALID_ARGUMENT：按参数表检查类型、范围和必填项；NOT_FOUND：确认 URI 或资源 ID 存在；INTERNAL：记录 request ID 后重试，持续失败时提交工单。

最近更新时间：2026.09.22 22:12:21

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

示例一：读取目录概览 #

参数、示例与排错补充 #

示例一：读取目录概览

参数、示例与排错补充