FastGPTFastGPT

创建空集合/目录

在指定知识库中创建空虚拟集合(virtual)或集合文件夹(folder),支持配置集合标签列表与独立权限继承选项。

端点概览

  • HTTP 方法:POST
  • 请求路径:/api/core/dataset/collection/create
  • 所属模块:知识库 / 集合创建
  • 鉴权方式:Authorization: Bearer <apiKey>—个人密钥(按归属团队成员资源权限校验)(详见 API 入门:完成首次请求)
  • 在线调试:在云服务 Scalar 调试台打开(自部署实例请将域名替换为 <instance>/apidoc/systemopenapi#tag/%E9%9B%86%E5%90%88%E5%88%9B%E5%BB%BA/POST/core/dataset/collection/create)

接口说明与注意事项

创建空数据集合或者目录

请求参数

Request Body 请求体(application/json)

字段类型必填默认值约束与说明
datasetIdstring是-数据集 ID
parentIdstring | null否-父级目录 ID
namestring是-集合名称
typestring (enum)是-集合类型(folder: 文件夹,virtual: 手动集合)。可选值:folder , virtual
tagsstring | object[]否-标签列表。字符串元素为旧格式标签名(按名称归并到 default_tag array 标签);对象元素为 { tag: 标签名, value: 标签值 },按标签名解析
inheritPermissionboolean否-是否继承父级权限(默认 true),仅对文件夹(type=folder)生效,仅供 sangfor 使用(FastGPT UI 未使用):true = 继承父级(根 folder 继承 dataset);false = 独立创建,仅写 owner 权限快照、不合并父级权限,父级后续权限变更也不再传播到该节点;传 false 时所属知识库必须已启用文件级权限,否则返回 collectionPermissionDisabled

请求示例

调用前请将 YOUR_API_KEY 与示例 ID 替换为真实值;私有化部署实例请将基础域名替换为 <instance>/api。

cURL 请求示例

curl --fail-with-body -X POST "https://cloud.fastgpt.cn/api/core/dataset/collection/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "datasetId": "string",
  "name": "string",
  "type": "folder"
}'

最小合法 JSON 请求体示例

{
  "datasetId": "string",
  "name": "string",
  "type": "folder"
}

响应结构与示例

除兼容 OpenAI 协议的对话补全或二进制下载接口外,成功响应统一包裹在 { "code": 200, "statusText": "", "message": "", "data": ... } 标准结构中;下方 200 字段表对应 data 载荷结构(若契约未声明具体载荷结构,请以上方状态描述及实际响应为准)。

HTTP 200

成功返回新创建的集合 ID

返回 FastGPT 标准成功响应结构({ "code": 200, "statusText": "", "message": "", "data": ... })。当前 OpenAPI 契约暂未声明 data 的具体字段结构,请结合上方状态描述或实际返回结果处理。

在 GitHub 上编辑

文件更新时间

本页导航

准备好开始了吗?

让你的企业知识真正被 AI 用起来