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

搜索文档

按 keyword 搜索当前身份可访问的文档,可选按 spaceId 限定空间。

请求体

名称类型必填描述示例值
keywordstring是搜索关键词。退款
spaceIdint64否可选,限定空间 ID。123456
pageint32否页码。1
pageSizeint32否每页数量。10

返回参数

名称类型描述示例值
codeint32业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。200
msgstring响应说明。成功通常为 ok;失败时为错误原因。ok
messagestring兼容字段,部分异常场景可能返回错误说明。
dataobject搜索结果。
└totalint64总数。10
└docsobject[]文档列表。
└docIdint64文档 ID。987654
└spaceIdint64空间 ID。123456
└spaceNamestring空间名称。产品知识库
└titlestring文档标题。退款规则
└summarystring命中的摘要内容。命中退款规则相关说明...
└updateTimestring最近更新时间。2026-06-12 11:00:00

错误码

状态码描述
400请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。
401PERSONAL_API 鉴权失败。常见业务码:405 AUTH_FAILED。
404资源不存在。常见业务码:404 NOT_FOUND。
500服务内部异常。常见业务码:500 ERROR。
postEndpoint
/api/athena/agent/tool/searchDoc
POST
/api/athena/agent/tool/searchDoc
curl -X POST "https://b.163.com/api/athena/agent/tool/searchDoc" \  -H "Content-Type: application/json" \  -d '{    "keyword": "退款"  }'
{
  "code": 200,
  "msg": "ok",
  "message": "string",
  "data": {
    "total": 10,
    "docs": [
      {
        "docId": 987654,
        "spaceId": 123456,
        "spaceName": "产品知识库",
        "title": "退款规则",
        "summary": "命中退款规则相关说明...",
        "updateTime": "2026-06-12 11:00:00"
      }
    ]
  }
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}

这篇文档有帮助吗?