创建文件夹¶

在卷或现有文件夹下创建文件夹。

POST https://api.moi.matrixorigin.cn/v5/catalog/folder/create

调用前准备¶

先查询数据库中的对象取得父卷或父文件夹 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和父卷或父文件夹 ID。调用者需要根卷的写入权限。

请求体¶

请求示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/folder/create" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_volume_id": '"$VOLUME_ID"',
    "database_id": '"$DATABASE_ID"',
    "name": "<FOLDER_NAME>",
    "description": "<FOLDER_DESCRIPTION>"
  }'

参数说明

请求体

字段	类型	必填	说明
`parent_volume_id`	integer	是	父卷或父文件夹 ID；服务将其解析到根卷。
`database_id`	integer	是	所属数据库 ID。
`name`	string	是	文件夹名称，必须是有效标识符。
`description`	string	否	文件夹描述。

成功响应¶

成功时返回 200 和新文件夹 ID。调用者需要根卷和所属数据库的写入权限。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": "901"
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。

创建结果

下面表格展开响应示例中 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`id`	string	新建文件夹的 ID，以数值字符串返回。后续调用需要整数 ID 的接口时，使用该数值本身。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "name 无效",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误信息。
`data`	null	错误响应中的附加数据；本示例为 `null`。

后续操作¶

记录 data.id。用该 ID 查询 Catalog 详情确认保存结果。

最后更新于 2026 年 9 月 28 日