知识库Agent Tool导航接口
查询目录下文档
查询指定空间和目录下的文档列表。folderId 不传时默认为根目录 0。
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| spaceId | int64 | 是 | 知识库空间 ID。 | 123456 |
| folderId | int64 | 否 | 目录 ID,根目录为 0。 | 0 |
| needFaqDetail | boolean | 否 | 是否返回 FAQ 或只读问答文档的扩展内容。 | false |
| needValidity | boolean | 否 | 是否返回文档有效期信息。 | false |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。 | 200 |
| msg | string | 响应说明。成功通常为 ok;失败时为错误原因。 | ok |
| message | string | 兼容字段,部分异常场景可能返回错误说明。 | |
| data | object | 文档列表数据。 | |
| └docs | object[] | 文档列表。 | |
| └docId | int64 | 文档 ID。 | 987654 |
| └title | string | 文档标题。 | 退款规则 |
| └type | string | 文档类型。 | MARKDOWN |
| └updater | string | 最近更新人。 | zhangsan |
| └updateTime | string | 最近更新时间。 | 2026-06-12 11:00:00 |
| └validityType | int32 | 有效期类型:1-永久有效,2-自定义有效期,3-已失效。 | 2 |
| └validStartTime | int64 | 有效期开始时间,毫秒时间戳;自定义有效期时返回。 | 1781245600000 |
| └validEndTime | int64 | 有效期结束时间,毫秒时间戳;自定义有效期时返回。 | 1812781599000 |
| └extendContent | string | FAQ 或只读问答文档扩展内容,序列化为 JSON 字符串。 |
错误码
| 状态码 | 描述 |
|---|---|
| 400 | 请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。 |
| 401 | PERSONAL_API 鉴权失败。常见业务码:405 AUTH_FAILED。 |
| 404 | 资源不存在。常见业务码:404 NOT_FOUND。 |
| 500 | 服务内部异常。常见业务码:500 ERROR。 |
postEndpoint
/api/athena/agent/tool/listDocscurl -X POST "https://b.163.com/api/athena/agent/tool/listDocs" \ -H "Content-Type: application/json" \ -d '{ "spaceId": 123456 }'{
"code": 200,
"msg": "ok",
"message": "string",
"data": {
"docs": [
{
"docId": 987654,
"title": "退款规则",
"type": "MARKDOWN",
"updater": "zhangsan",
"updateTime": "2026-06-12 11:00:00",
"validityType": 2,
"validStartTime": 1781245600000,
"validEndTime": 1812781599000,
"extendContent": "string"
}
]
}
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}这篇文档有帮助吗?