知识库知识库外部开放接口
获取单个知识点详情
根据 docId、UUID 或两者联合获取一条文档详情;联合传入时必须对应,响应包含文档、解析、审核和有效期状态。
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| spaceId | int64 | 否 | 知识库空间 ID。 | 123456 |
| docId | int64 | 否 | 文档 ID;与 uuid 至少传一个。 | 987654 |
| uuid | string | 否 | 客户文档 UUID;与 docId 同传时必须对应。 | customer-doc-001 |
| publicTag | int32 | 否 | 公开标识,当前接口未显式使用。 | 1 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。 | 200 |
| msg | string | 响应说明。成功通常为 ok;失败时为错误原因。 | ok |
| message | string | 兼容字段,部分异常场景可能返回错误说明。 | |
| data | object[] | 文档详情列表;当前只返回一条记录。 | |
| └docId | int64 | 文档 ID。 | 987654 |
| └spaceId | int64 | 所属空间 ID。 | 123456 |
| └docName | string | 文档或目录名称。 | 退款规则 |
| └parentId | int64 | 父目录 ID;根目录通常为 0。 | 0 |
| └docType | string | 文档类型。 | |
| └creator | string | 创建人账号或 GUID。 | zhangsan |
| └creatorName | string | 创建人姓名。 | 张三 |
| └createTime | int64 | 创建时间,毫秒时间戳。 | 1781245600000 |
| └editor | string | 最近编辑人账号或 GUID。 | lisi |
| └editorName | string | 最近编辑人姓名。 | 李四 |
| └editTime | int64 | 最近编辑时间,毫秒时间戳。 | 1781249200000 |
| └deleter | string | 删除人账号或 GUID,仅已删除数据返回。 | wangwu |
| └deleterName | string | 删除人姓名,仅已删除数据返回。 | 王五 |
| └deleteTime | int64 | 删除时间,毫秒时间戳,仅已删除数据返回。 | 1781252800000 |
| └deleteFlag | boolean | 是否已删除。 | false |
| └uuid | string | 客户文档 UUID。 | customer-doc-001 |
| └docStatus | int32 | 文档生命周期状态,-1 表示已物理移除。 | |
| └analysisStatus | int32 | AI 解析状态。 | |
| └analysisProgress | double | AI 解析进度。 | |
| └analysisLog | string | AI 解析说明。 | |
| └contentValidType | int32 | 内容审核状态。 | |
| └validReason | string | 内容审核说明。 | |
| └validityType | int32 | 有效期类型。 | |
| └validStartTime | int64 | 有效期开始时间。 | |
| └validEndTime | int64 | 有效期结束时间。 | |
| └effective | boolean | 文档当前是否可生效召回。 |
错误码
| 状态码 | 描述 |
|---|---|
| 400 | 请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。 |
| 401 | OPENAPI_AUTH 鉴权失败。常见业务码:405 AUTH_FAILED。 |
| 404 | 资源不存在。常见业务码:404 NOT_FOUND、408 SPACE_NOT_EXISTS。 |
| 500 | 服务内部异常。常见业务码:500 ERROR。 |
postEndpoint
/api/athena/openApi/external/getDocInfocurl -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"
}这篇文档有帮助吗?