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

获取文档属性列表

获取指定文档的属性值列表。

请求体

名称类型必填描述示例值
spaceIdint64是知识库空间 ID。123456
docIdint64是文档 ID。987654
expireDaysint32否外部预览链接有效天数,必须大于 0,且不能超过服务端配置上限。7

返回参数

名称类型描述示例值
codeint32业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。200
msgstring响应说明。成功通常为 ok;失败时为错误原因。ok
messagestring兼容字段,部分异常场景可能返回错误说明。
dataobject文档属性数据。
└metaListobject[]属性列表。
└metaIdint64属性 ID。1001
└metaNamestring属性名称。产品线
└metaValuestring属性值。售后

错误码

状态码描述
400请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。
401PERSONAL_API 鉴权失败。常见业务码:405 AUTH_FAILED。
404资源不存在。常见业务码:404 NOT_FOUND。
500服务内部异常。常见业务码:500 ERROR。
postEndpoint
/api/athena/agent/tool/getDocMetaList
POST
/api/athena/agent/tool/getDocMetaList
curl -X POST "https://b.163.com/api/athena/agent/tool/getDocMetaList" \  -H "Content-Type: application/json" \  -d '{    "spaceId": 123456,    "docId": 987654  }'
{
  "code": 200,
  "msg": "ok",
  "message": "string",
  "data": {
    "metaList": [
      {
        "metaId": 1001,
        "metaName": "产品线",
        "metaValue": "售后"
      }
    ]
  }
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}

这篇文档有帮助吗?