通过 OpenAPI 获取通义灵码知识库文件列表。
适用版本 | 企业专属版、企业标准版 |
服务接入点
获取服务接入点,替换 API 请求语法中的 {domain}
。
授权信息
产品 | 资源 | 所需权限 |
通义灵码 | 知识库文件 | 只读 |
请求语法
GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases/{kbId}/files
请求说明 | 企业标准版获取该知识库下所有文件列表
根据文件名称模糊查询该知识库下文件列表
获取该知识库下文件列表并根据知识库添加时间排序
企业专属版获取该知识库下所有文件列表
根据文件名称模糊查询该知识库下文件列表
获取该知识库下文件列表并根据知识库添加时间排序
|
请求头(Headers) | |
x-yunxiao-token 个人访问令牌。您可参考个人访问令牌获取。 示例:pt-0fh3****0fbG_35af****0484。 | |
请求参数 | |
organizationId 所属组织ID。您可以前往组织管理后台的基本信息页面获取organizationId。 | |
kbId 知识库 ID。请参见获取知识库列表获取知识库ID。 | |
query 文件名称模糊查询。 | |
orderBy 排序列,支持如下排序字段:
| |
sort 排序顺序:
| |
page 当前页。 | |
perPage 每页数据条数的最大值,取值范围: |
返回参数 | 返回示例
|
fileId 文件 ID。 | |
filePath 文件路径。 | |
fileSize 文件大小。 | |
fileState 文件状态。 | |
file_md5 文件内容的md5值,用来唯一标识一个文件。 | |
filename 文件名称。 | |
gmtAdded 添加时间。 | |
gmtCreated 创建时间。 | |
gmtModified 修改时间。 | |
kdId 知识库 ID。 | |
organizationId 所属组织 ID。 | |
uploadUser 文件添加者。 |
响应头
参数 | 描述 | 示例值 |
x-next-page | 下一页 | 1 |
x-page | 当前页 | 1 |
x-per-page | 每页大小 | 20 |
x-prev-page | 前一页 | 1 |
x-total | 总数 | 9 |
x-total-pages | 总分页数 | 1 |
错误码
访问错误码中心查看 API 相关错误码。