知识库Agent Tool导航接口
搜索文档
按 keyword 搜索当前身份可访问的文档,可选按 spaceId 限定空间。
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| keyword | string | 是 | 搜索关键词。 | 退款 |
| spaceId | int64 | 否 | 可选,限定空间 ID。 | 123456 |
| page | int32 | 否 | 页码。 | 1 |
| pageSize | int32 | 否 | 每页数量。 | 10 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。 | 200 |
| msg | string | 响应说明。成功通常为 ok;失败时为错误原因。 | ok |
| message | string | 兼容字段,部分异常场景可能返回错误说明。 | |
| data | object | 搜索结果。 | |
| └total | int64 | 总数。 | 10 |
| └docs | object[] | 文档列表。 | |
| └docId | int64 | 文档 ID。 | 987654 |
| └spaceId | int64 | 空间 ID。 | 123456 |
| └spaceName | string | 空间名称。 | 产品知识库 |
| └title | string | 文档标题。 | 退款规则 |
| └summary | string | 命中的摘要内容。 | 命中退款规则相关说明... |
| └updateTime | string | 最近更新时间。 | 2026-06-12 11:00:00 |
错误码
| 状态码 | 描述 |
|---|---|
| 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/searchDoccurl -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"
}这篇文档有帮助吗?