删除集合
按单个集合 ID、集合 ID 列表或外部 API 文件 ID 批量删除一个或多个集合及其子集合(仅集合所有者可操作)。
端点概览
- HTTP 方法:
POST - 请求路径:
/api/core/dataset/collection/delete - 所属模块:知识库 / 集合管理
- 鉴权方式:
Authorization: Bearer <apiKey>—个人密钥(按归属团队成员资源权限校验)(详见 API 入门:完成首次请求) - 在线调试:在云服务 Scalar 调试台打开(自部署实例请将域名替换为
<instance>/apidoc/systemopenapi#tag/%E9%9B%86%E5%90%88%E7%AE%A1%E7%90%86/POST/core/dataset/collection/delete)
接口说明与注意事项
删除一个或多个集合及其子集合。请求体三选一:body.id(单个集合)、body.collectionIds(集合列表)、body.datasetId + body.apiFileIds(API 文件库外部文件或目录 ID)。仅集合所有者(owner)可删除;持有 manage/write 权限的协作者不可删除。按 apiFileIds 定位时全部未命中会返回集合不存在错误。旧版 query.id 仍兼容但已弃用,请改用 body.id;使用 query.id 时请求体可缺失或为 {},同时提供合法请求体时 query.id 优先,非法请求体仍会被拒绝。未提供任何定位参数时拒绝请求
请求参数
参数定位组合(多选一):请提供以下任意一组定位参数:
body.id或body.collectionIds或body.datasetId+body.apiFileIds或query.id。
Query 查询参数
| 字段 | 类型 | 必填 | 默认值 | 约束与说明 |
|---|---|---|---|---|
id | string | 否 | - | 已弃用。旧版用于指定单个集合 ID,已弃用,请改用 body.id |
Request Body 请求体(application/json)
互斥参数分支(anyOf 选填其一)
- 按集合 ID 删除
删除单个集合及其全部子集合
| 字段 | 类型 | 必填 | 默认值 | 约束与说明 |
|---|---|---|---|---|
id | string | 是 | - | 集合 ID,删除该集合及其全部子集合。最小长度:1 |
- 按集合 ID 列表删除
批量删除多个集合及其全部子集合
| 字段 | 类型 | 必填 | 默认值 | 约束与说明 |
|---|---|---|---|---|
collectionIds | string[] | 是 | - | 集合 ID 列表,删除每个集合及其全部子集合。最少项数:1 |
- 按 API 文件 ID 删除
外部集成只知道外部文件或目录 ID 时使用:在指定知识库内按 apiFileId 定位集合,删除命中的集合及其全部子集合
| 字段 | 类型 | 必填 | 默认值 | 约束与说明 |
|---|---|---|---|---|
datasetId | string | 是 | - | API 文件库对应的知识库 ID。最小长度:1 |
apiFileIds | string[] | 是 | - | API 文件库的外部文件或目录 ID 列表;全部未命中时返回集合不存在。最少项数:1 |
- 旧版
query.id兼容
仅通过旧版 query.id 定位时允许空请求体;未提供任何定位参数时拒绝请求
该分支无需额外字段。
请求示例
调用前请将 YOUR_API_KEY 与示例 ID 替换为真实值;私有化部署实例请将基础域名替换为 <instance>/api。
cURL 请求示例
curl --fail-with-body -X POST "https://cloud.fastgpt.cn/api/core/dataset/collection/delete" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
--data-raw '{
"id": "68ad85a7463006c963799a05"
}'最小合法 JSON 请求体示例
{
"id": "68ad85a7463006c963799a05"
}响应结构与示例
除兼容 OpenAI 协议的对话补全或二进制下载接口外,成功响应统一包裹在 { "code": 200, "statusText": "", "message": "", "data": ... } 标准结构中;下方 200 字段表对应 data 载荷结构(若契约未声明具体载荷结构,请以上方状态描述及实际响应为准)。
HTTP 200
成功删除集合
返回 FastGPT 标准成功响应结构({ "code": 200, "statusText": "", "message": "", "data": ... })。当前 OpenAPI 契约暂未声明 data 的具体字段结构,请结合上方状态描述或实际返回结果处理。
文件更新时间