FastGPTFastGPT

获取知识库列表 V2

分页查询或按 datasetIds 精确检索当前成员可访问的知识库与文件夹列表,支持类型过滤、关键词搜索与集合文件数统计。

端点概览

  • HTTP 方法:POST
  • 请求路径:/api/core/dataset/listV2
  • 所属模块:知识库 / 知识库管理
  • 鉴权方式: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/listV2)

接口说明与注意事项

分页获取或按 datasetIds 精确查询当前用户有权限访问的知识库;提供 datasetIds 时优先按 ID 查询,解析时过滤 parentId 和分页参数,保留公共筛选字段

请求参数

Request Body 请求体(application/json)

各分支公共字段

字段类型必填默认值约束与说明
typestring | array否-知识库类型筛选
searchKeystring否-搜索关键词,按名称和简介模糊匹配
sortstring (enum)否"updateTimeDesc"列表排序,缺省按最近修改倒序。可选值:updateTimeDesc (按修改时间倒序,最近修改的排在前面(默认)), createTimeDesc (按创建时间倒序,最新创建的排在前面), createTimeAsc (按创建时间升序,最早创建的排在前面)
tmbIdsstring[]否-按创建者筛选;空数组返回空列表
withAppCountboolean否-是否返回被正式应用引用的数量;默认不统计,仅非文件夹资源的 Owner 可查看
withFileCountboolean否-是否计算并返回知识库文件总数,默认不计算;统计所有层级的非目录集合,不按文件权限过滤

互斥参数分支(anyOf 选填其一)

  • 按 IDs 获取
字段类型必填默认值约束与说明
datasetIdsstring[]是-按知识库或文件夹 ID 精确查询,最多 500 个;优先匹配该分支,解析时过滤 parentId 和分页参数,保留公共筛选字段。最少项数:1;最多项数:500
  • 分页获取
字段类型必填默认值约束与说明
parentIdstring | null否-父级文件夹 ID;null 或空字符串表示根目录;搜索时限定在指定目录及其子树,不传则搜索全部可读知识库

按偏移量获取: 通过 offset 指定起始位置,从 0 开始;同时传入页码时优先使用 offset。

字段类型必填默认值约束与说明
offsetinteger是-互斥参数组:分页参数。偏移量,从 0 开始。最小值:0;最大值:9007199254740991
pageSizeinteger否20互斥参数组:分页参数。每页条数,默认 20,最大 500,超出自动按 500 处理。最大值:500

按页码获取: 通过页码获取,默认第 1 页;pageSize 控制每页条数。

字段类型必填默认值约束与说明
pageNuminteger否1互斥参数组:分页参数。页码,从 1 开始;传入 offset 时忽略。最大值:9007199254740991
pageSizeinteger否20互斥参数组:分页参数。每页条数,默认 20,最大 500,超出自动按 500 处理。最大值:500

请求示例

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

cURL 请求示例

curl --fail-with-body -X POST "https://cloud.fastgpt.cn/api/core/dataset/listV2" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "datasetIds": [
    "68ad85a7463006c963799a05"
  ]
}'

最小合法 JSON 请求体示例

{
  "datasetIds": ["68ad85a7463006c963799a05"]
}

响应结构与示例

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

HTTP 200

成功返回知识库列表

Content-Type : application/json

字段类型必填默认值约束与说明
totalnumber是0-
listobject[]是[]-
list[]._idstring是-数据集 ID。正则:^[0-9a-fA-F]{24}$
list[].tmbIdstring是-团队成员 ID。正则:^[0-9a-fA-F]{24}$
list[].avatarstring是"/icon/logo.svg"头像
list[].createTimestring是-创建时间
list[].updateTimestring是-更新时间
list[].namestring是-名称
list[].introstring是-简介
list[].typestring (enum)是-数据集类型。可选值:folder , dataset , websiteDataset , externalFile , apiDataset , feishu , yuque , dingtalk
list[].permissionobject是-权限对象序列化后的 JSON 结构
list[].permission.roleinteger是-权限角色值。最小值:-9007199254740991;最大值:9007199254740991
list[].permission.isOwnerboolean是-是否为所有者
list[].permission.hasManagePerboolean是-是否拥有管理权限
list[].permission.hasWritePerboolean是-是否拥有写权限
list[].permission.hasReadPerboolean是-是否拥有读权限
list[].permission.hasManageRoleboolean是-是否包含管理角色
list[].permission.hasWriteRoleboolean是-是否包含写角色
list[].permission.hasReadRoleboolean是-是否包含读角色
list[].appCountinteger否-被正式应用引用的数量,开启引用统计时仅非文件夹资源的 Owner 返回。最小值:0;最大值:9007199254740991
list[].fileCountinteger否-知识库所有层级的非目录集合数量,不按文件权限过滤;仅 listV2 请求 withFileCount 时返回,folder 类型不返回。最小值:0;最大值:9007199254740991
list[].vectorModelobject否-向量模型;目录或模型已删除时为空,已停用模型仍返回展示数据
list[].vectorModel.pricingobject否-每固定计价单位的积分单价;缺省免费
list[].vectorModel.pricing.unitPricenumber否-综合单价;Token/TTS 每百万数量,STT 时长模式固定为每 60 秒。最小值:0
list[].vectorModel.providerstring是-最小长度:1
list[].vectorModel.modelstring是-最小长度:1
list[].vectorModel.namestring是-最小长度:1
list[].vectorModel.scopestring (enum)是"system"可选值:system , team
list[].vectorModel.sortOrderinteger否-同一作用域内的模型展示 rank,数值越小越靠前。最小值:0;最大值:9007199254740991
list[].vectorModel.tmbIdstring | null否--
list[].vectorModel.teamIdstring | null否--
list[].vectorModel.isActiveboolean否--
list[].vectorModel.isUpcomingDeprecationboolean否-模型是否即将下架
list[].vectorModel.requestUrlstring否--
list[].vectorModel.requestAuthstring否--
list[].vectorModel.testModeboolean否--
list[].vectorModel.type"embedding"是-固定值:"embedding"
list[].vectorModel.configobject是--
list[].vectorModel.config.defaultTokennumber是--
list[].vectorModel.config.maxTokennumber是--
list[].vectorModel.config.weightnumber是0-
list[].vectorModel.config.hiddenboolean否--
list[].vectorModel.config.visionboolean否--
list[].vectorModel.config.normalizationboolean否--
list[].vectorModel.config.batchSizenumber否--
list[].vectorModel.config.defaultConfigobject否--
list[].vectorModel.config.dbConfigobject否--
list[].vectorModel.config.queryConfigobject否--
list[].vectorModel.modelIdstring是--
list[].vectorModel.avatarstring否--
list[].inheritPermissionboolean是-继承权限
list[].privateboolean否-是否私有
list[].folderAccessModestring (enum)否-文件夹访问方式;navigate 仅允许浏览可读后代,不授予真实读取权限。可选值:read , navigate
list[].sourceMemberobject否-来源成员
list[].sourceMember.namestring是-成员名称
list[].sourceMember.avatarstring | null否-成员头像
list[].sourceMember.statusstring (enum)是-成员状态。可选值:active , leave , forbidden
在 GitHub 上编辑

文件更新时间

本页导航

准备好开始了吗?

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