mkdir-创建目录--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

请输入

文件系统操作 (File System Operations)

mkdir-创建目录

概述

/api/v1/fs/mkdir 接口用于在 OpenViking 文件系统中创建目录。创建时可指定目录初始说明，该说明会写入 .abstract.md 并进入目录 L0 向量化队列。

前置条件

完成 API 鉴权说明页面的 API Key 获取后，可调用本接口创建目录。

请求接口

URI	/api/v1/fs/mkdir	统一资源标识符
请求方法	POST	客户端请求类型
请求头	Content-Type: application/json	请求消息类型
	Authorization: Bearer	Bearer Token 鉴权

请求参数

参数	类型	必选	默认值	备注
uri	string	是	--	新目录的 Viking URI
description	string	否	null	目录初始说明传入后会写入该目录的 `.abstract.md`，并进入目录 L0 向量化队列。未指定时不创建 `.abstract.md`。

响应消息

字段	参数说明
status	请求状态，成功为 `"ok"`，失败为 `"error"`
result	成功时返回的数据对象
result.uri	创建的目录 URI，格式为 `viking://resources/<path>/`
telemetry	遥测信息，通常为 `null`
error	失败时返回的错误对象
error.code	错误码字符串，常见值见下表
error.message	可读的错误描述

常见错误码：

error.code	说明
UNAUTHENTICATED	缺少或无效的 API Key
PERMISSION_DENIED	权限不足
INVALID_ARGUMENT	无效参数
INVALID_URI	无效的 Viking URI 格式
ALREADY_EXISTS	目录已存在

完整示例

示例一：创建目录（无说明）

curl -X POST https://xxx/api/v1/fs/mkdir \
  -H "X-Api-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "uri": "viking://resources/new-project/"
  }'

执行成功返回：

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

{
    "status": "ok",
    "result": {
        "uri": "viking://resources/new-project/"
    },
    "error": null,
    "telemetry": null
}

示例二：创建目录并指定说明

curl -X POST https://xxx/api/v1/fs/mkdir \
  -H "X-Api-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "uri": "viking://resources/new-project/",
    "description": "接口文档目录"
  }'

执行成功返回：

{
    "status": "ok",
    "result": {
        "uri": "viking://resources/new-project/"
    },
    "error": null,
    "telemetry": null
}

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

示例一：创建目录（无说明） #

示例二：创建目录并指定说明 #

示例一：创建目录（无说明）

示例二：创建目录并指定说明