获取知识库列表

获取可用知识库文档列表

请求头

xi-api-keystring可选

查询参数

page_sizeinteger可选1-100默认为 30

最多返回的文档数量。不能超过 100,默认为 30。

searchstring or null可选

指定后,此端点仅返回名称以此字符串开头的知识库文档。

show_only_owned_documentsboolean可选默认为 falseDeprecated

设为 true 时,此端点仅返回你拥有的文档(不包括他人分享的文档)。已弃用:请改用 created_by_user_id。

created_by_user_idstring or null可选

按创建者用户 ID 筛选文档。设置后,仅返回该用户创建的文档。此项优先于 show_only_owned_documents。使用 ‘@me’ 表示已认证用户。

typeslist of enums or null可选

提供后,端点仅返回指定类型的文档。

允许的值:
parent_folder_idstring or null可选

设定后,此端点仅返回指定文件夹的直接子文档。

ancestor_folder_idstring or null可选

设定后,此端点仅返回指定文件夹的后代文档。

folders_firstboolean可选默认为 false

是否在文档列表中优先返回文件夹。

sort_directionenum可选

结果排序方向

允许的值:
sort_byenum or null可选

用于排序结果的字段

允许的值:
cursorstring or null可选

用于获取下一页。响应中会返回游标。

响应

成功响应

documentslist of objects
has_moreboolean
next_cursorstring or null可选

错误

422
Unprocessable Entity Error