知识管理

获取知识列表

Changed on

获取知识库下的知识列表，支持分页和筛选 不传 parse_status 时不返回删除中（deleting）的文档。

get/knowledge-bases/{id}/knowledge

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/knowledge-bases/{id}/knowledge
  • Auth
    • API key in header Authorization
    • or API key in header X-API-Key

Path parameters

idstring required

知识库ID

Query parameters

pageinteger

页码

page_sizeinteger

每页数量

tag_idsstring

标签ID筛选，逗号分隔（OR语义）

keywordstring

关键词搜索

file_typestring

文件类型筛选

parse_status'pending' | 'processing' | 'finalizing' | 'completed' | 'failed' | 'cancelled' | 'deleting'

状态

sourcestring

来源/渠道筛选 (web/api/feishu/notion/yuque/wechat/...，或 manual/url 按 type 过滤)

start_timestring

更新时间起点，RFC3339 格式

end_timestring

更新时间终点，RFC3339 格式

folder_pathstring

文件夹路径筛选，空字符串表示知识库根目录；不传该参数则不按文件夹过滤

folder_recursiveboolean

为 true 时同时返回子文件夹内的文档

sort_by'created_at' | 'updated_at' | 'file_name'

排序字段

sort_order'asc' | 'desc'

排序方向

Response

知识列表

pageinteger
page_sizeinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes