七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
知识库Agent Tool导航接口

查询目录下文档

查询指定空间和目录下的文档列表。folderId 不传时默认为根目录 0。

请求体

名称类型必填描述示例值
spaceIdint64是知识库空间 ID。123456
folderIdint64否目录 ID,根目录为 0。0
needFaqDetailboolean否是否返回 FAQ 或只读问答文档的扩展内容。false
needValidityboolean否是否返回文档有效期信息。false

返回参数

名称类型描述示例值
codeint32业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。200
msgstring响应说明。成功通常为 ok;失败时为错误原因。ok
messagestring兼容字段,部分异常场景可能返回错误说明。
dataobject文档列表数据。
└docsobject[]文档列表。
└docIdint64文档 ID。987654
└titlestring文档标题。退款规则
└typestring文档类型。MARKDOWN
└updaterstring最近更新人。zhangsan
└updateTimestring最近更新时间。2026-06-12 11:00:00
└validityTypeint32有效期类型:1-永久有效,2-自定义有效期,3-已失效。2
└validStartTimeint64有效期开始时间,毫秒时间戳;自定义有效期时返回。1781245600000
└validEndTimeint64有效期结束时间,毫秒时间戳;自定义有效期时返回。1812781599000
└extendContentstringFAQ 或只读问答文档扩展内容,序列化为 JSON 字符串。

错误码

状态码描述
400请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。
401PERSONAL_API 鉴权失败。常见业务码:405 AUTH_FAILED。
404资源不存在。常见业务码:404 NOT_FOUND。
500服务内部异常。常见业务码:500 ERROR。
postEndpoint
/api/athena/agent/tool/listDocs
POST
/api/athena/agent/tool/listDocs
curl -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"
}

这篇文档有帮助吗?