# 问答对接口

# 创建问答对

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/kb/faqs

请求头

参数 是否必须 说明
Content-Type 是 固定值:"application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式:"Bearer access_token"
示例值:"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"
x-staff-id 是 成员帐号,作为问答对创建人,需具有 kb_entry 节点编辑权限

其他说明

事项 说明
权限要求 创建问答对
授权范围 AppKey绑定团队时,入参data.relationships.entry.data.id所在知识库需在授权团队范围内
频率限制 3000次/分钟

请求参数

{
  "data": {
    "type": "kb_faq",
    "attributes": {
      "question": "如何使用乐享知识库?",
      "answer": "登录后可以在知识库中创建、编辑和分享知识内容。",
      "answer_summary": "登录后可在知识库中创建、编辑和分享知识内容",
      "similar_questions": [
        "乐享知识库怎么用?",
        "乐享知识库使用方法"
      ]
    },
    "relationships": {
      "entry": {
        "data": {
          "type": "kb_entry",
          "id": "3e7293e48cf14e4081932d839ceb2d6d"
        }
      }
    }
  }
}

参数说明

参数 是否必须 说明
data.type 否 固定值 kb_faq
data.attributes.question 是 问题内容,1~500 个字符
data.attributes.answer 是 标准答案,支持富文本 HTML,1~2000 个字符
data.attributes.answer_summary 否 答案摘要(纯文本);未提供时,系统会自动使用去除 HTML 标签后的 answer 作为摘要
data.attributes.similar_questions 否 相似问题列表,最多 10 条。每项不能为空,也不能重复
data.attributes.similar_questions.* 否 相似问题内容;similar_questions 不为空时每项必填
data.relationships.entry 是 问答对归属的知识节点
data.relationships.entry.data.type 否 固定值 kb_entry
data.relationships.entry.data.id 是 知识节点 ID,最大 36 个字符

响应

200 Ok 状态码

{
  "data": {
    "type": "kb_faq",
    "id": "b8c7d6e5f4a3",
    "attributes": {
      "question": "如何使用乐享知识库?",
      "answer": "登录后可以在知识库中创建、编辑和分享知识内容。",
      "answer_summary": "登录后可在知识库中创建、编辑和分享知识内容",
      "similar_questions": [
        "乐享知识库怎么用?",
        "乐享知识库使用方法"
      ],
      "created_at": "2026-07-06 15:00:00",
      "updated_at": "2026-07-06 15:00:00"
    },
    "relationships": {
      "owner": {
        "data": {
          "type": "staff",
          "id": "LX001"
        }
      },
      "entry": {
        "data": {
          "type": "kb_entry",
          "id": "3e7293e48cf14e4081932d839ceb2d6d"
        }
      }
    }
  },
  "included": [
    {
      "type": "staff",
      "id": "LX001",
      "attributes": {
        "name": "张三",
        "english_name": "zhangsan",
        "organization": "开发组"
      }
    },
    {
      "type": "kb_entry",
      "id": "3e7293e48cf14e4081932d839ceb2d6d",
      "attributes": {
        "name": "产品使用指南"
      }
    }
  ]
}

参数说明

参数 说明
id 问答对 ID
question 问题内容
answer 标准答案
answer_summary 答案摘要
similar_questions 相似问题列表
created_at 创建时间
updated_at 更新时间
relationships.owner 问答对创建人,可根据 id 在 included 中查找
relationships.entry 问答对归属的知识节点,可根据 id 在 included 中查找

# 更新问答对

请求URL

PUT https://lxapi.lexiangla.com/cgi-bin/v1/kb/faqs/{faq_id}

请求头

参数 是否必须 说明
Content-Type 是 固定值:"application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式:"Bearer access_token"
示例值:"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"
x-staff-id 是 成员帐号,作为问答对更新人,需要有该问答对所在知识节点的编辑权限。
若不希望指定操作者或忽略权限校验,可设置为固定值:"system-bot"

其他说明

事项 说明
权限要求 更新问答对
授权范围 AppKey绑定团队时,该问答对所在知识库需在授权团队范围内
频率限制 3000次/分钟
未传字段 请求里没出现的字段保持原值,不会用空值覆盖

URL 参数说明

参数 是否必须 说明
faq_id 是 问答对 ID,最大 36 个字符

请求参数

{
  "data": {
    "attributes": {
      "question": "如何使用乐享知识库?",
      "answer": "<p>登录后可以在知识库中创建、编辑和分享知识内容。</p>",
      "answer_summary": "登录后可以在知识库中创建、编辑和分享知识内容。",
      "similar_questions": [
        "乐享知识库怎么用?",
        "乐享知识库使用方法"
      ]
    }
  }
}

参数说明

参数 是否必须 说明
data.type 否 固定值 kb_faq
data.id 否 传入时须与路径中的 faq_id 相同
data.attributes.question 否 问题内容,1~500 个字符。不传保持原值;传空字符串返回 400,不会写成空
data.attributes.answer 否 标准答案,支持富文本 HTML,最大 2000 个字符。不传保持原值;传空字符串返回 400,不会写成空
data.attributes.answer_summary 否 答案摘要(纯文本)。不传保持原值;传空字符串会覆盖成空摘要
data.attributes.similar_questions 否 相似问题列表,只接受字符串数组。不传保持原值;传空数组会清空;传入数组则整包覆盖。最多 10 条

响应

200 Ok 状态码

{
  "data": {
    "type": "kb_faq",
    "id": "b8c7d6e5f4a3",
    "attributes": {
      "question": "如何使用乐享知识库?",
      "answer": "登录后可以在知识库中创建、编辑和分享知识内容。",
      "answer_summary": "登录后可以在知识库中创建、编辑和分享知识内容。",
      "similar_questions": [
        "乐享知识库怎么用?",
        "乐享知识库使用方法"
      ],
      "created_at": "2026-07-06 15:00:00",
      "updated_at": "2026-07-06 15:00:00"
    },
    "relationships": {
      "owner": {
        "data": {
          "type": "staff",
          "id": "LX001"
        }
      },
      "entry": {
        "data": {
          "type": "kb_entry",
          "id": "3e7293e48cf14e4081932d839ceb2d6d"
        }
      }
    }
  },
  "included": [
    {
      "type": "staff",
      "id": "LX001",
      "attributes": {
        "name": "张三",
        "english_name": "zhangsan",
        "organization": "开发组"
      }
    },
    {
      "type": "kb_entry",
      "id": "3e7293e48cf14e4081932d839ceb2d6d",
      "attributes": {
        "name": "产品使用指南"
      }
    }
  ]
}

参数说明

参数 说明
id 问答对 ID
question 问题内容
answer 标准答案。与列表、创建一致,返回的是答案摘要
answer_summary 答案摘要
similar_questions 相似问题列表
created_at 创建时间
updated_at 更新时间
relationships.owner 问答对创建人,可根据 id 在 included 中查找
relationships.entry 问答对归属的知识节点,可根据 id 在 included 中查找

# 删除问答对

请求URL

DELETE https://lxapi.lexiangla.com/cgi-bin/v1/kb/faqs/{faq_id}

请求头

参数 是否必须 说明
Authorization 是 接口调用凭证 access_token
值格式:"Bearer access_token"
示例值:"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"
x-staff-id 是 成员帐号,作为问答对删除人,需要有该问答对所在知识节点的编辑权限。
若不希望指定操作者或忽略权限校验,可设置为固定值:"system-bot"

其他说明

事项 说明
权限要求 删除问答对
授权范围 AppKey绑定团队时,该问答对所在知识库需在授权团队范围内
频率限制 3000次/分钟

URL 参数说明

参数 是否必须 说明
faq_id 是 问答对 ID,最大 36 个字符

响应

204 No Content

# 获取问答对列表

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/kb/faqs

请求头

参数 是否必须 说明
Authorization 是 接口调用凭证 access_token
值格式:"Bearer access_token"
示例值:"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"
x-staff-id 否 成员帐号,用于按当前成员可见范围过滤,需具有 kb_entry 节点查看权限

其他说明

事项 说明
权限要求 获取问答对列表
授权范围 AppKey绑定团队时,入参entry_id所在知识库需在授权团队范围内
频率限制 3000次/分钟
列表排序 根据传入的sort_by参数排序;不传时按接口默认顺序返回

参数说明

参数 是否必须 说明
entry_id 是 知识节点 ID,最大 36 个字符
limit 否 每页个数,1~1000 以内的整数,默认 50
page_token 否 分页游标,根据上一页返回的 page_token 传入
sort_by 否 排序字段,只允许 created_at、updated_at。例如 -created_at(按创建时间倒序)、updated_at(按更新时间升序)
include 否 附加返回信息(如 faq_mode),最多 100 字符

响应

200 Ok 状态码

{
  "data": [
    {
      "type": "kb_faq",
      "id": "b8c7d6e5f4a3",
      "attributes": {
        "question": "如何使用乐享知识库?",
        "answer": "登录后可以在知识库中创建、编辑和分享知识内容。",
        "answer_summary": "登录后可在知识库中创建、编辑和分享知识内容",
        "similar_questions": [
          "乐享知识库怎么用?",
          "乐享知识库使用方法"
        ],
        "created_at": "2026-07-06 15:00:00",
        "updated_at": "2026-07-06 15:00:00"
      },
      "relationships": {
        "owner": {
          "data": {
            "type": "staff",
            "id": "LX001"
          }
        },
        "entry": {
          "data": {
            "type": "kb_entry",
            "id": "3e7293e48cf14e4081932d839ceb2d6d"
          }
        }
      }
    }
  ],
  "included": [
    {
      "type": "staff",
      "id": "LX001",
      "attributes": {
        "name": "张三",
        "english_name": "zhangsan",
        "organization": "开发组"
      }
    },
    {
      "type": "kb_entry",
      "id": "3e7293e48cf14e4081932d839ceb2d6d",
      "attributes": {
        "name": "产品使用指南"
      }
    }
  ],
  "meta": {
    "page_token": "WyIyMDI2LTA3LTA2VDE1OjAwOjAwKzA4OjAwIiwxMDFd"
  }
}

参数说明

参数 说明
id 问答对 ID
question 问题内容
answer 标准答案
answer_summary 答案摘要
similar_questions 相似问题列表
created_at 创建时间
updated_at 更新时间
relationships.owner 问答对创建人,可根据 id 在 included 中查找
relationships.entry 问答对归属的知识节点,可根据 id 在 included 中查找
meta.page_token 下一页游标,为空时表示没有下一页