知识库知识库外部开放接口
更新文档文件
通过 docId、UUID 或两者联合定位并更新文档;联合传入时必须对应且不允许换绑 UUID。单租户并发上传上限为 10。
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| spaceId | int64 | 是 | 知识库空间 ID。 | 123456 |
| docId | int64 | 否 | 文档 ID;与 uuid 至少传一个。 | 987654 |
| uuid | string | 否 | 客户文档 UUID;与 docId 同传时必须对应。 | customer-doc-001 |
| title | string | 是 | 文档标题,1 到 256 字符。 | 产品手册.pdf |
| classify | int32 | 否 | 文档分类,默认 1。 | 1 |
| newUrl | string | 是 | 新的文件 URL。 | https://example.com/product-v2.pdf |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。 | 200 |
| msg | string | 响应说明。成功通常为 ok;失败时为错误原因。 | ok |
| message | string | 兼容字段,部分异常场景可能返回错误说明。 | |
| data | object | 导入或更新结果。docId=-1 时 errMsg 描述失败原因。 | |
| └docId | int64 | 导入或更新后的文档 ID;失败时可能为 -1。 | 987654 |
| └uuid | string | 客户文档 UUID。 | customer-doc-001 |
| └errMsg | string | 导入或更新结果说明;成功为 success,失败为具体原因。 | success |
错误码
| 状态码 | 描述 |
|---|---|
| 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/updateDoccurl -X POST "https://b.163.com/api/athena/openApi/external/updateDoc" \ -H "Content-Type: application/json" \ -d '{ "spaceId": 123456, "title": "产品手册.pdf", "newUrl": "https://example.com/product-v2.pdf" }'{
"code": 200,
"msg": "ok",
"message": "string",
"data": {
"docId": 987654,
"uuid": "customer-doc-001",
"errMsg": "success"
}
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}这篇文档有帮助吗?