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

导入文档

通过文件 URL 导入文档。UUID 可选;传入时同租户重复 UUID 幂等返回已有 docId,不传时沿用原创建逻辑。单租户并发上传上限为 10。

请求体

名称类型必填描述示例值
spaceIdint64是知识库空间 ID。123456
parentIdint64是父目录 ID,根目录为 0。0
uuidstring否可选的客户文档 UUID;传入时启用幂等,数字或字符均按字符串原样处理。customer-doc-001
titlestring是文档标题,1 到 256 字符。产品手册.pdf
classifyint32否文档分类,默认 1。1
urlstring是可访问的文件 URL。https://example.com/product.pdf
ruleIdint64否解析规则 ID,默认 0。0
compressionTypestring是文件类型,当前支持 Word、PDF、Excel 等。pdf

返回参数

名称类型描述示例值
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/importDoc
POST
/api/athena/openApi/external/importDoc
curl -X POST "https://b.163.com/api/athena/openApi/external/importDoc" \  -H "Content-Type: application/json" \  -d '{    "spaceId": 123456,    "parentId": 0,    "title": "产品手册.pdf",    "url": "https://example.com/product.pdf",    "compressionType": "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"
}

这篇文档有帮助吗?