FastGPTFastGPT

创建知识库

创建一个新的 FastGPT 知识库或文件夹,支持通用知识库、网站同步、外部文件库与第三方数据源配置及权限继承设置。

端点概览

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

接口说明与注意事项

创建新的知识库,支持多种类型(普通知识库、文件夹、网站知识库等)

请求参数

Request Body 请求体(application/json)

字段类型必填默认值约束与说明
parentIdstring | null否-父级文件夹 ID,不传则创建在根目录
typestring (enum)是-知识库类型。可选值:folder , dataset , websiteDataset , externalFile , apiDataset , feishu , yuque , dingtalk
namestring是-知识库名称
introstring是-知识库简介
avatarstring否-知识库头像,可不传,返回时使用默认图标
vectorModelIdstring否-向量模型 ID,不传则使用默认向量模型
vectorModelstring否-已弃用。向量模型标识,不传则使用默认向量模型
agentModelIdstring否-知识库 Agent 模型 ID,不传则使用默认模型
agentModelstring否-已弃用。知识库 Agent 模型标识,不传则使用默认模型
vlmModelIdstring | null否-视觉语言模型 ID;未传沿用默认,null 或空字符串表示不设置
vlmModelstring否-已弃用。视觉语言模型标识
apiDatasetServerobject否-第三方知识库服务器配置(API/飞书/语雀/钉钉)
apiDatasetServer.apiServerobject否-API 服务器配置
apiDatasetServer.apiServer.baseUrlstring是--
apiDatasetServer.apiServer.authorizationstring否--
apiDatasetServer.apiServer.basePathstring否--
apiDatasetServer.feishuServerobject否-飞书服务器配置
apiDatasetServer.feishuServer.appIdstring是--
apiDatasetServer.feishuServer.appSecretstring否--
apiDatasetServer.feishuServer.folderTokenstring是--
apiDatasetServer.yuqueServerobject否-语雀服务器配置
apiDatasetServer.yuqueServer.userIdstring是--
apiDatasetServer.yuqueServer.tokenstring否--
apiDatasetServer.yuqueServer.basePathstring否--
apiDatasetServer.dingtalkServerobject否-钉钉知识库配置
apiDatasetServer.dingtalkServer.appKeystring是--
apiDatasetServer.dingtalkServer.appSecretstring否--
apiDatasetServer.dingtalkServer.userIdstring是--
apiDatasetServer.dingtalkServer.operatorIdstring否--
apiDatasetServer.dingtalkServer.workspaceIdstring否--
apiDatasetServer.dingtalkServer.rootNodeIdstring否--
apiDatasetServer.dingtalkServer.workspaceNamestring否--
sangforFileParseConfigobject否-外部文档解析开关(页眉页脚/附录/图片识别/图转表),仅对 customPdfParse 解析路径生效
sangforFileParseConfig.keep_header_footerboolean否-是否保留页眉页脚,默认关闭(删除页眉页脚)
sangforFileParseConfig.keep_appendixboolean否-是否保留附录,默认开启
sangforFileParseConfig.image_analysisboolean否-是否保留图片识别(含印章)结果,默认关闭
sangforFileParseConfig.chart_analysisboolean否-是否保留图表转表格结果(同时保留原图片),默认关闭
inheritPermissionboolean否-是否继承父级权限(默认 true):true = 创建时合并父级权限快照,并跟随父级后续权限变更;false = 独立创建,仅写创建者 owner 权限,不合并父级权限,父级后续权限变更也不再传播到该节点

请求示例

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

cURL 请求示例

curl --fail-with-body -X POST "https://cloud.fastgpt.cn/api/core/dataset/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "folder",
  "name": "我的知识库",
  "intro": "这是一个用于存储产品文档的知识库"
}'

最小合法 JSON 请求体示例

{
  "type": "folder",
  "name": "我的知识库",
  "intro": "这是一个用于存储产品文档的知识库"
}

响应结构与示例

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

HTTP 200

成功返回新创建的知识库 ID

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

在 GitHub 上编辑

文件更新时间

本页导航

准备好开始了吗?

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