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

获取文档详情

根据 spaceId 和 docId 获取文档基础信息。

请求体

名称类型必填描述示例值
spaceIdint64是知识库空间 ID。123456
docIdint64是文档 ID。987654
expireDaysint32否外部预览链接有效天数,必须大于 0,且不能超过服务端配置上限。7

返回参数

名称类型描述示例值
codeint32业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。200
msgstring响应说明。成功通常为 ok;失败时为错误原因。ok
messagestring兼容字段,部分异常场景可能返回错误说明。
dataobject文档详情。
└titlestring文档标题。退款规则
└descriptionstring文档描述。售后退款相关规则
└typestring文档类型。MARKDOWN
└creatorstring创建人。zhangsan
└editorstring最近编辑人。lisi
└pathstring文档所在路径。/售后/退款规则
└createTimestring创建时间。2026-06-12 10:00:00
└updateTimestring更新时间。2026-06-12 11:00:00
└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/getDocDetail
POST
/api/athena/agent/tool/getDocDetail
curl -X POST "https://b.163.com/api/athena/agent/tool/getDocDetail" \  -H "Content-Type: application/json" \  -d '{    "spaceId": 123456,    "docId": 987654  }'
{
  "code": 200,
  "msg": "ok",
  "message": "string",
  "data": {
    "title": "退款规则",
    "description": "售后退款相关规则",
    "type": "MARKDOWN",
    "creator": "zhangsan",
    "editor": "lisi",
    "path": "/售后/退款规则",
    "createTime": "2026-06-12 10:00:00",
    "updateTime": "2026-06-12 11:00:00",
    "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"
}

这篇文档有帮助吗?