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

更新文档(文件字节)

通过 multipart/form-data 上传已有文档的新版本。支持 docId、UUID 或两者联合定位;联合传入时必须对应。签名覆盖表单字段,fileSha256 用于文件完整性校验。

请求体

名称类型必填描述示例值
spaceIdint64是知识库空间 ID。123456
docIdint64否文档 ID;与 uuid 至少传一个。987654
uuidstring否客户文档 UUID;与 docId 同传时必须对应。customer-doc-001
titlestring是新文档标题。产品手册-v2.pdf
classifyint32否文档分类,默认 1。1
compressionTypestring是文件类型,例如 doc、docx、pdf、xlsx、xls、md。pdf
fileSha256string是文件内容的 SHA-256 十六进制摘要。a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
filestring是

返回参数

名称类型描述示例值
codeint32业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。200
msgstring响应说明。成功通常为 ok;失败时为错误原因。ok
messagestring兼容字段,部分异常场景可能返回错误说明。
dataobject导入或更新结果。docId=-1 时 errMsg 描述失败原因。
└docIdint64导入或更新后的文档 ID;失败时可能为 -1。987654
└uuidstring客户文档 UUID。customer-doc-001
└errMsgstring导入或更新结果说明;成功为 success,失败为具体原因。success

错误码

状态码描述
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/updateDocByFile
POST
/api/athena/openApi/external/updateDocByFile
curl -X POST "https://b.163.com/api/athena/openApi/external/updateDocByFile" \  -F spaceId="123456" \  -F title="产品手册-v2.pdf" \  -F compressionType="pdf" \  -F fileSha256="a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447" \  -F file="string"
{
  "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"
}

这篇文档有帮助吗?