Skip to main content
GET
获取数据源页面列表

Authorizations

Authorization
string
header
required

每个请求都通过 API 密钥认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API 密钥,知识库接口使用知识库 API 密钥(快速开始)。

API 密钥应保存在服务端,切勿嵌入客户端代码。缺失或无效的密钥会返回 HTTP 401(unauthorized)。

Path Parameters

knowledge_base_id
string<uuid>
required

知识库 ID:即知识库 API 访问 对话框中所示服务 API 端点的最后一段(…/knowledge-fs/spaces/<knowledge base ID>),也是地址栏中 /datasets/new/ 之后的那一段。

source_id
string<uuid>
required

数据源 ID,通过 获取数据源列表 获取。

Query Parameters

cursor
string

上一次响应中的 next_cursor。将其视为不透明字符串。树形视图下翻页时,保持 view、parentId 和 limit 不变。

Required string length: 1 - 4096
limit
integer
default:50

每次响应返回的页面数。

Required range: 1 <= x <= 200
view
enum<string>

传入 tree 时只列出页面树的一层:顶层,或 parentId 下的页面。不传则返回平铺列表。

官方数据源插件中只有 GitHub 支持树形视图,需要插件 0.4.12 或更高版本。

要获取 GitHub 仓库中的文件,需使用树形视图。两种方式都最多覆盖最近更新的 20 个仓库。在这些仓库下,两者能列出的页面不同:

  • 树形视图:每个仓库下有 Contents、Issues(仓库开启了 issue 时)和 Pull requests。Contents 下是仓库的文件夹和可导入的文本文件,文件夹可继续逐层展开。
  • 平铺列表:每个仓库本身及其 README(如有),外加最多 5 个 issue 和 5 个 pull request。
Available options:
tree
parentId
string

要展开的页面的 page_id,取自之前树形视图响应中 has_children 为 true 的页面。须与 view=tree 一起使用。

注意参数名是驼峰写法的 parentId,对应的响应字段则是 parent_id。

Required string length: 1 - 4096

Response

按工作空间分组的页面。

next_cursor
string | null

下一页的游标,最后一页时为 null。将其作为 cursor 传回。

workspaces
object[]

凭据可见的提供商工作空间。