read-读取完整内容（L2）--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

请输入

文件内容

read-读取完整内容（L2）

概述

/api/v1/content/read 接口用于读取 OpenViking 文件系统中文件的 L2 完整内容。

read() 只接受文件 URI。传入已存在的目录 URI 时返回 INVALID_ARGUMENT（400），而不是 NOT_FOUND。公开 URI 参数只接受 resources、user、agent、session 作用域。temp、queue 等内部作用域会返回 INVALID_URI。

前置条件

完成 API 鉴权说明页面的 API Key 获取后，可调用本接口读取内容。

请求接口

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

请求参数

参数	类型	必选	默认值	备注
uri	string	是	--	Viking URI 文件 URI。传入目录 URI 时返回 `INVALID_ARGUMENT`。
offset	int	否	0	起始行号（0 开始）
limit	int	否	-1	读取的行数，`-1` 表示读到结尾

响应消息

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

常见错误码：

error.code	HTTP 状态码	说明
UNAUTHENTICATED	401	缺少或无效的 API Key
INVALID_ARGUMENT	400	无效参数，如 uri 为目录而非文件
INVALID_URI	400	无效的 Viking URI 格式，或使用了非公开作用域（如 `temp`、`queue`）
NOT_FOUND	404	资源未找到

完整示例

示例一：读取文件完整内容

curl -X GET "https://xxx/api/v1/content/read?uri=viking://resources/docs/api.md" \
  -H "X-API-Key: your-key"

执行成功返回：

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

{
    "status": "ok",
    "result": "# 对话导出记录\n\n> 导出时间：2026年4月\n> 项目：广西旅行行程网页开发\n\n---\n\n## 说明\n\n本文件导出的是本次任务会话中「用户/助手」的对话内容...",
    "error": null,
    "telemetry": null
}

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

示例一：读取文件完整内容 #

示例一：读取文件完整内容