1. agent
askxbot开放API
  • askxbot-openapi使用说明
    • 概述
    • 交互技术说明
    • Agent会话调用接口流程
  • agent
    • agent查询
      GET
    • Agent对话-session创建
      POST
    • Agent对话-智能会话
      POST
    • Agent对话-知识检索
      POST
    • Agent对话-自定义
      POST
    • Agent对话-信息收集
      POST
    • Agent对话-对话流
      POST
    • agent统计日志
      GET
    • agent日志详情
      GET
    • 会话消息点赞/踩
      POST
    • 会话消息修正
      POST
    • 会话消息重试-智能会话
      POST
    • 会话消息重试-知识检索
      POST
    • Agent对话-更新用户定义的变量值
      POST
  • 工作流
    • 工作流查询
      GET
    • 工作运行记录
      GET
    • 工作流输入变量查询
      GET
    • 工作流运行
      POST
  • 知识库
    • 文档知识库
      • v2-多级文档知识库目录
        • 创建子目录文档
        • 子级目录文档树形结构
        • 更新子级文档知识库
        • 删除子级文档知识库
      • 文档知识库列表
      • 文档知识库详情
      • 创建文档知识库
      • 更新文档知识库
      • 删除文档知识库
      • 重试失败文档知识
      • 查询指定文档知识库全部知识
      • 向文档知识库添加知识
      • 更新指定文档知识库指定知识
      • 查询指定文档知识库指定知识
      • 删除指定文档知识库指定知识
    • 问答知识库
      • 问答知识库列表
      • 问答知识库详情
      • 创建问答知识库
      • 更新问答知识库
      • 删除文档知识库
      • 重试失败问答知识
      • 导出问答知识库所有问答知识
      • 查询指定问答知识库全部问答
      • 向问答知识库添加问答
      • 更新指定问答知识库指定问答
      • 删除指定问答知识库指定问答
  • 数据模型
    • Knowledge
      • FaqInventoryCreateDto
      • DocumentInventoryDocumentUpdateDto
      • PageFaqInventorySearchVo
      • DocumentInventoryDocumentDetailVo
      • EmbeddingConfig
      • UpdateEmbeddingConfig
      • FaqInventoryCreateVo
      • FaqInventoryCreateWrapper
      • FaqInventoryFaqSearchVo
      • FaqInventorySearchVo
      • DocumentInventorySearchWrapper
      • PageDocumentInventoryDocumentSearch
      • DocumentInventoryDetailVo
      • PageFaqInventoryFaqSearchVo
      • DocumentInventoryDocumentSearchVo
      • DocumentInventoryDetailWrapper
      • AgentInfo
      • PageDocumentInventorySearchVo
      • DocumentInventorySearchVo
      • DocumentInventoryCreateDto
      • StringResultVo
      • DocumentInventoryDocumentSearchWrapper
      • DocumentInventoryDocumentDetailWrapper
      • FaqInventorySearchWrapper
      • FaqInventoryDetailVo
      • FaqInventoryDetailWrapper
      • FaqInventoryUpdateDto
      • FaqInventoryFaqSearchWrapper
      • FaqInventoryFaqAddDto
      • FaqInventoryFaqUpdateDto
  1. agent

Agent对话-知识检索

POST
https://api.xbotspace.com/agent-api/v1/open/agents/chat
该接口使用sse技术开发（具体细节可查阅网上教程），通过服务器与客户端的http长连接，根据传递的delayInMs间隔返回消息，每次返回的消息格式为json
样例数据：
可将每次返回json中的data.content.answer拼接，即可获得完整的回复内容，如果Agent配置开启展示片段引用，返回的引用的片段格式为:ref[片段编号]，如:ref[1]，:ref[2],回复完成后会在最后一次响应数据中返回文档引用信息字段data.content.pages，最后服务器会自动断开链接
data中其他字段描述：
字段描述备注
sessionSn会话唯一标识
msgSn消息唯一标识
source消息来源：user用户 bot机器人 system系统
msgTime消息发送时间
content消息体
content.answer响应文本
content.reasoningContent响应思考过程文本
content.pages文档引用页信息
content.pages.fileId文档唯一标识
content.pages.fileName文档名称
content.pages.fileType文档类型
content.pages.fileDownloadUrl文件下载链接
content.pages.pageList页码列表
content.pages.pageList.page页码
content.pages.pageList.pageContent页码内容
content.pages.pageList.score内容评分
content.pages.pageList.llmRefNumberllm引用片段编号， 在answer字段中以:ref[llmRefNumber]返回，如ref[1]
content.pages.pageList.sourceImageUrl片段来源图片下载地址
content.imagePages召回图片所在文档引用页信息
content.imagePages.fileId文档唯一标识
content.imagePages.fileName文档名称
content.imagePages.fileType文档类型
content.imagePages.fileDownloadUrl文件下载链接
content.imagePages.list召回图片列表
content.imagePages.list.page召回图片所在页码
content.imagePages.list.imageSn召回图片唯一标识
content.imagePages.list.imageName召回图片名称
content.imagePages.list.score召回图片评分
content.imagePages.list.imageDownloadUrl召回图片下载链接
content.imagePages.pageList.llmRefNumberllm引用片段编号， 在answer字段中以:ref[llmRefNumber]返回，如ref[1]
content.imagePages.pageList.sourceImageUrl片段来源图片下载地址

请求参数

Header 参数

Body 参数application/x-www-form-urlencoded

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://api.xbotspace.com/agent-api/v1/open/agents/chat' \
--header 'Authorization: 2e1a7423-2f39-488a-a1d0-26b3bd416548' \
--data-urlencode 'sessionSn=session-f26de888cfbf48dda89c2' \
--data-urlencode 'msgContent=[[@dataSet::ABC知识库::f0ce3026]]什么是iBom' \
--data-urlencode 'msgType=text' \
--data-urlencode 'requestType=0' \
--data-urlencode 'delayInMs=20' \
--data-urlencode 'stream=true' \
--data-urlencode 'promptParamValues={"name":"自定义变量_文本","value":"abcd","type":"text"}' \
--data-urlencode 'promptParamValues={"name":"自定义变量_段落类型","value":"333333","type":"string"}' \
--data-urlencode 'promptParamValues={"name": "自定义变量_单选类型", "type": "radio", "value": "选项1"}'

返回响应

🟢200成功
text/event-stream
Bodytext/event-stream

示例
data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368853228,"time":"2024/06/26 10:27","messageStatusStr":"知识搜索中...","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368853688,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368854421,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368855015,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368855203,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368855847,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368856034,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368857295,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368858030,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368858664,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368859067,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368859489,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368860261,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368860628,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368860703,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368861251,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"sending","msgTime":1719368861448,"time":"2024/06/26 10:27","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":"bot","msgStatus":"normal","msgTime":1719368866031,"time":"2024/06/26 10:27","content":{"answer":"i"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-1da630847d0d40ea89bdd","msgSn":"msg-b9cc1c81833c41648c827","msgType":"docref","source":
修改于 2025-07-29 07:53:30
上一页
Agent对话-智能会话
下一页
Agent对话-自定义
Built with