清空文件夹¶

清空指定文件夹及其子文件夹中的内容。该操作会删除文件和子文件夹，执行前请确认目标文件夹。

POST https://moi.matrixorigin.cn/newmoi/catalog/folder/clean

调用前准备¶

先查询文件列表取得目标文件夹 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件夹 ID。

下方示例使用：

$AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。
$WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。
$FOLDER_ID：要清空的文件夹 ID。

调用者需要根卷的写入权限。

请求体¶

参数	类型	是否必填	说明
`id`	integer	是	文件夹 ID。

请求示例¶

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/folder/clean" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$FOLDER_ID"'
  }'

成功响应¶

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

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

响应字段如下。

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

错误响应¶

{
  "code": "ErrReadonly",
  "msg": "对象不可写",
  "data": null
}

常见 HTTP 错误¶

HTTP 状态码	错误代码	常见原因	建议操作
`400`	`ErrParamInvalid`	`id` 缺失或请求格式无效。	传入有效的文件夹 ID。
`403`	`ErrForbidden`	当前身份没有根卷的写入权限。	使用有写入权限的凭据，或联系管理员授权。
`409`	`ErrReadonly`	文件夹所在数据库不可写。	选择可写卷中的文件夹。
`500`	`ErrServer`	服务无法清空文件夹。	记录请求时间和错误信息后重试；持续失败时联系支持人员。

后续操作¶

完成后查询 Catalog 详情确认当前状态。

最后更新于 2026 年 8 月 22 日