完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

文件夹

文件夹相关操作

获取文件夹

获取项目内的文件夹，支持筛选、排序、字段选择和分页。

GET/projects/{projectId}/folders

请求参数

参数	位置	类型	必填	说明
projectId	path	string	是	项目的 ID。
filter	query	string	否	以 JSON 编码的筛选对象。支持的字段包括 parentFolderId、name、tags（标签名称数组）、excludeFolderIdAndDescendants。
select	query	string	否	以 JSON 编码的待包含字段数组。有效字段包括 id、name、createdAt、updatedAt、project、tags、parentFolder、workflowCount、subFolderCount、path。
sortBy	query	string	否	结果排序顺序。 可选值：name:asc, name:desc, createdAt:asc, createdAt:desc, updatedAt:asc, updatedAt:desc
skip	query	string	否	分页时跳过的数据项数量，默认为 0。
take	query	string	否	返回的数据项数量，默认为 10。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
count	integer	是	符合查询条件的文件夹总数。
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 只读。 data.[]name string 否 data.[]parentFolderId string 否 data.[]createdAt string 否 只读。 data.[]updatedAt string 否 只读。 data.[]homeProject object 否 展开字段 字段 类型 必填 说明 data.[]homeProject.id string 是 只读。 data.[]homeProject.name string 是 data.[]homeProject.type string 是 可选值：personal, team 只读。 data.[]homeProject.icon object 是 项目图标；项目没有图标时为 null data.[]parentFolder object 否 展开字段 字段 类型 必填 说明 data.[]parentFolder.id string 是 只读。 data.[]parentFolder.name string 是 data.[]parentFolder.parentFolderId string 是 data.[]tags array 否 data.[]workflowCount number 否 文件夹包含的工作流数量。 只读。 data.[]subFolderCount number 否 文件夹包含的文件夹数量。 只读。 data.[]path array 否 从项目根目录到此文件夹路径上每个文件夹的名称。 只读。

下载完整 OpenAPI 定义（JSON）

创建文件夹

在项目内创建文件夹。

POST/projects/{projectId}/folders

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。
projectId	path	string	是	项目的 ID；设为 personal 时，在调用用户自己的个人项目中创建文件夹。

请求体

application/json

字段	类型	必填	说明
name	string	是
parentFolderId	string	否

响应

状态码	说明
201	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

响应结构：201 · application/json

字段	类型	必填	说明
id	string	是	只读。
name	string	是
parentFolderId	string	是
createdAt	string	是	只读。
updatedAt	string	是	只读。

下载完整 OpenAPI 定义（JSON）

获取文件夹详情

获取文件夹详情，包括子文件夹和工作流数量。

GET/projects/{projectId}/folders/{folderId}

请求参数

参数	位置	类型	必填	说明
projectId	path	string	是	项目的 ID。
folderId	path	string	是	文件夹的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是	只读。
name	string	是
parentFolderId	string	是
createdAt	string	是	只读。
updatedAt	string	是	只读。
totalSubFolders	integer	是	子文件夹总数（递归统计）。
totalWorkflows	integer	是	工作流总数（递归统计）。

下载完整 OpenAPI 定义（JSON）

删除文件夹

删除项目内的文件夹。提供 `transferToFolderId` 时，删除之前会将工作流和子文件夹移至目标文件夹。省略时，工作流会移至项目根目录并归档，子文件夹会被删除。

DELETE/projects/{projectId}/folders/{folderId}

请求参数

参数	位置	类型	必填	说明
projectId	path	string	是	项目的 ID。
folderId	path	string	是	文件夹的 ID。
transferToFolderId	query	string	否	可选的目标文件夹 ID，用于在删除之前接收工作流和子文件夹。

响应

状态码	说明
204	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

下载完整 OpenAPI 定义（JSON）

更新文件夹

更新文件夹名称或父文件夹。

PATCH/projects/{projectId}/folders/{folderId}

请求参数

参数	位置	类型	必填	说明
projectId	path	string	是	项目的 ID。
folderId	path	string	是	文件夹的 ID。

请求体

application/json

字段	类型	必填	说明
name	string	否
parentFolderId	string	否	要将此文件夹移入的父文件夹 ID。设为 "0" 可将其移至项目根目录。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是	只读。
name	string	是
parentFolderId	string	是
createdAt	string	是	只读。
updatedAt	string	是	只读。

下载完整 OpenAPI 定义（JSON）