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

获取单个知识点详情

根据 docId、UUID 或两者联合获取一条文档详情;联合传入时必须对应,响应包含文档、解析、审核和有效期状态。

请求体

名称类型必填描述示例值
spaceIdint64否知识库空间 ID。123456
docIdint64否文档 ID;与 uuid 至少传一个。987654
uuidstring否客户文档 UUID;与 docId 同传时必须对应。customer-doc-001
publicTagint32否公开标识,当前接口未显式使用。1

返回参数

名称类型描述示例值
codeint32业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。200
msgstring响应说明。成功通常为 ok;失败时为错误原因。ok
messagestring兼容字段,部分异常场景可能返回错误说明。
dataobject[]文档详情列表;当前只返回一条记录。
└docIdint64文档 ID。987654
└spaceIdint64所属空间 ID。123456
└docNamestring文档或目录名称。退款规则
└parentIdint64父目录 ID;根目录通常为 0。0
└docTypestring文档类型。PDF
└creatorstring创建人账号或 GUID。zhangsan
└creatorNamestring创建人姓名。张三
└createTimeint64创建时间,毫秒时间戳。1781245600000
└editorstring最近编辑人账号或 GUID。lisi
└editorNamestring最近编辑人姓名。李四
└editTimeint64最近编辑时间,毫秒时间戳。1781249200000
└deleterstring删除人账号或 GUID,仅已删除数据返回。wangwu
└deleterNamestring删除人姓名,仅已删除数据返回。王五
└deleteTimeint64删除时间,毫秒时间戳,仅已删除数据返回。1781252800000
└deleteFlagboolean是否已删除。false
└uuidstring客户文档 UUID。customer-doc-001
└docStatusint32文档生命周期状态,-1 表示已物理移除。
└analysisStatusint32AI 解析状态。
└analysisProgressdoubleAI 解析进度。
└analysisLogstringAI 解析说明。
└contentValidTypeint32内容审核状态。
└validReasonstring内容审核说明。
└validityTypeint32有效期类型。
└validStartTimeint64有效期开始时间。
└validEndTimeint64有效期结束时间。
└effectiveboolean文档当前是否可生效召回。

错误码

状态码描述
400请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。
401OPENAPI_AUTH 鉴权失败。常见业务码:405 AUTH_FAILED。
404资源不存在。常见业务码:404 NOT_FOUND、408 SPACE_NOT_EXISTS。
500服务内部异常。常见业务码:500 ERROR。
postEndpoint
/api/athena/openApi/external/getDocInfo
POST
/api/athena/openApi/external/getDocInfo
curl -X POST "https://b.163.com/api/athena/openApi/external/getDocInfo" \  -H "Content-Type: application/json" \  -d '{}'
{
  "code": 200,
  "msg": "ok",
  "message": "string",
  "data": [
    {
      "docId": 987654,
      "spaceId": 123456,
      "docName": "退款规则",
      "parentId": 0,
      "docType": "PDF",
      "creator": "zhangsan",
      "creatorName": "张三",
      "createTime": 1781245600000,
      "editor": "lisi",
      "editorName": "李四",
      "editTime": 1781249200000,
      "deleter": "wangwu",
      "deleterName": "王五",
      "deleteTime": 1781252800000,
      "deleteFlag": false,
      "uuid": "customer-doc-001",
      "docStatus": 0,
      "analysisStatus": 0,
      "analysisProgress": 0.1,
      "analysisLog": "string",
      "contentValidType": 0,
      "validReason": "string",
      "validityType": 0,
      "validStartTime": 0,
      "validEndTime": 0,
      "effective": true
    }
  ]
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}

这篇文档有帮助吗?