更新文件夹¶

更新文件夹信息；提供 name 时会校验其是否为有效标识符。

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

调用前准备¶

先查询文件列表取得目标文件夹 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件夹 ID。调用者需要根卷的写入权限。

请求体¶

请求示例

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

参数说明

请求体

字段	类型	必填	说明
`id`	integer	是	文件夹 ID。
`name`	string	否	新名称。
`description`	string	否	新描述。

成功响应¶

成功时返回 200，data 为 null。调用者需要根卷的写入权限。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	null	更新成功时固定为 `null`。

错误响应¶

响应示例

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

字段说明

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

后续操作¶

用同一资源标识查询 Catalog 详情确认更新结果。

最后更新于 2026 年 9 月 11 日