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

创建快捷方式

为目标文档创建快捷方式。目标不能是文件夹。

请求体

名称类型必填描述示例值
spaceIdint64是知识库空间 ID。123456
parentIdint64否父目录 ID,根目录为 0。0
titlestring是快捷方式标题。FAQ 快捷方式
targetDocIdint64是目标文档 ID,不能是文件夹。987654

返回参数

名称类型描述示例值
codeint32业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。200
msgstring响应说明。成功通常为 ok;失败时为错误原因。ok
messagestring兼容字段,部分异常场景可能返回错误说明。
dataobject文档信息。
└docIdint64文档 ID。987654
└titlestring标题。FAQ

错误码

状态码描述
400请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。
401PERSONAL_API 鉴权失败。常见业务码:405 AUTH_FAILED。
403权限不足。常见业务码:406 FORBIDDEN。
404资源不存在。常见业务码:404 NOT_FOUND。
500服务内部异常。常见业务码:500 ERROR。
postEndpoint
/api/athena/agent/tool/createShortcut
POST
/api/athena/agent/tool/createShortcut
curl -X POST "https://b.163.com/api/athena/agent/tool/createShortcut" \  -H "Content-Type: application/json" \  -d '{    "spaceId": 123456,    "title": "FAQ 快捷方式",    "targetDocId": 987654  }'
{
  "code": 200,
  "msg": "ok",
  "message": "string",
  "data": {
    "docId": 987654,
    "title": "FAQ"
  }
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}

这篇文档有帮助吗?