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
样例数据：
对话流输出的变量通过data.content.outputs字段返回，可以按变量ID或者变量名称来区分变量
非流式输出(stream=false)直接返回全量变量列表
当输出选择流式模式(stream=true)+累加输出(streamMode=append，默认)时,会按定义顺序依次流式输出累加变量值，可将输出变量值直接覆盖
当输出选择流式模式(stream=true)+累加输出(streamMode=delta)时会按定义顺序依次流式输出增量变量值，需要自己处理累加后的变量值
可根据content.outputs.append字段值来判断是否需要累加，true表示返回的是增量的内容，需要累加，false表示的完整的内容，不需要做累加
data中其他字段描述：
字段描述备注
sessionSn会话唯一标识
msgSn消息唯一标识
source消息来源：user用户 bot机器人 system系统
msgTime消息发送时间
content消息体
content.outputs输出变量列表
content.outputs.name输出变量名称
content.outputs.id输出变量名称
content.outputs.type输出变量类型
content.outputs.output输出变量值
content.outputs.append消息内容是否需要累加,当streamMode=delta时生效，true表示返回的是增量的内容，false表示的完整的内容

请求参数

Header 参数

Body 参数multipart/form-data

请求示例代码

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: db67f3f2-23b2-4c3c-b47f-1ef23839a94c' \
--form 'sessionSn="session-7b0f025b6ba94ea7a8730"' \
--form 'msgContent="老虎"' \
--form 'msgType="text"' \
--form 'delayInMs="20"' \
--form 'stream="true"' \
--form 'files=@"F:\\下载\\logo.png"' \
--form 'promptParamValues="{\"name\":\"变量名称\",\"value\":\"abcd\",\"type\":\"text\"}"' \
--form 'promptParamValues="{\"name\":\"变量名称\",\"value\":\"abcd\",\"type\":\"string\"}"' \
--form 'promptParamValues="{\"name\": \"自定义文本\", \"type\": \"radio\", \"value\": \"选项1\"}"' \
--form 'promptParamValues="{\"name\": \"自定义文本\", \"type\": \"checkbox\", \"value\": \"[\\\"选项1\\\",\\\"选项2\\\"]\"}"' \
--form 'promptParamValues="{\"name\": \"json\", \"type\": \"json\", \"value\": \"{\\\"c\\\":1}\"}"' \
--form 'promptParamValues="{\"name\": \"自定义文本\", \"type\": \"textArr\", \"value\": \"[\\\"文本1\\\",\\\"文本2\\\"]\"}"' \
--form 'promptParamValues="{\"name\": \"json\", \"type\": \"jsonArr\", \"value\": \"[{\\\"c\\\":1},{\\\"c\\\":1}]\"}"' \
--form 'streamMode="append"'

返回响应

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

示例
data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564922499,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564923302,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564923330,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564924129,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564925130,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564926128,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564927128,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564928130,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564929120,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564930128,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564931129,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564932128,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564933129,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564934130,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564934685,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564934833,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564934861,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"","type":"TEXT","id":"5658cf6090","name":"文本","state":"loading"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935124,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未","type":"TEXT","id":"5658cf6090","name":"文本","state":"sending"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935145,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索","type":"TEXT","id":"5658cf6090","name":"文本","state":"sending"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935167,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到","type":"TEXT","id":"5658cf6090","name":"文本","state":"sending"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935189,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到相","type":"TEXT","id":"5658cf6090","name":"文本","state":"sending"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935210,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到相关","type":"TEXT","id":"5658cf6090","name":"文本","state":"sending"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935232,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到相关","type":"TEXT","id":"5658cf6090","name":"文本","state":"sending"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935255,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到相关知","type":"TEXT","id":"5658cf6090","name":"文本","state":"sending"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935277,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到相关知识","type":"TEXT","id":"5658cf6090","name":"文本","state":"sending"}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935299,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到相关知识","type":"TEXT","id":"5658cf6090","name":"文本","state":null},{"output":[],"type":"DOC","id":"5c47916cd0","name":"文档","state":null}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564935325,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到相关知识","type":"TEXT","id":"5658cf6090","name":"文本","state":null},{"output":[],"type":"DOC","id":"5c47916cd0","name":"文档","state":null},{"output":["https://xbot-dev.oss-cn-shanghai.aliyuncs.com/testDL/5d453739a4d64053bfc073022708f411?response-content-disposition=attachment%3B%20filename%3D%22xbot-chain-image.png%22&response-content-type=application%2Foctet-stream&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240628T085539Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=LTAI5tKfguCuncQ1jAnMfgbn%2F20240628%2Fcn-shanghai%2Fs3%2Faws4_request&X-Amz-Signature=191ecce1cf4010096d0a2f8af24bd6ca9fcbf18ea484841e2771b59f9aa04cd6"],"type":"IMAGE","id":"2310190c48","name":"图片","state":null}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564938431,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到相关知识","type":"TEXT","id":"5658cf6090","name":"文本","state":null},{"output":[],"type":"DOC","id":"5c47916cd0","name":"文档","state":null},{"output":["https://xbot-dev.oss-cn-shanghai.aliyuncs.com/testDL/5d453739a4d64053bfc073022708f411?response-content-disposition=attachment%3B%20filename%3D%22xbot-chain-image.png%22&response-content-type=application%2Foctet-stream&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240628T085539Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=LTAI5tKfguCuncQ1jAnMfgbn%2F20240628%2Fcn-shanghai%2Fs3%2Faws4_request&X-Amz-Signature=191ecce1cf4010096d0a2f8af24bd6ca9fcbf18ea484841e2771b59f9aa04cd6"],"type":"IMAGE","id":"2310190c48","name":"图片","state":null}],"references":null}}

data:{"sessionSn":"session-7b0f025b6ba94ea7a8730","msgSn":"msg-69694f5da04a4dd6ac6ef","msgType":"process","source":"bot","msgStatus":"normal","msgTime":1719564938454,"rate":0,"success":true,"time":"2024/06/28 16:55","content":{"outputs":[{"output":"未检索到相关知识","type":"TEXT","id":"5658cf6090","name":"文本","state":null},{"output":[],"type":"DOC","id":"5c47916cd0","name":"文档","state":null},{"output":["https://xbot-dev.oss-cn-shanghai.aliyuncs.com/testDL/5d453739a4d64053bfc073022708f411?response-content-disposition=attachment%3B%20filename%3D%22xbot-chain-image.png%22&response-content-type=application%2Foctet-stream&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240628T085539Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=LTAI5tKfguCuncQ1jAnMfgbn%2F20240628%2Fcn-shanghai%2Fs3%2Faws4_request&X-Amz-Signature=191ecce1cf4010096d0a2f8af24bd6ca9fcbf18ea484841e2771b59f9aa04cd6"],"type":"IMAGE","id":"2310190c48","name":"图片","state":null}],"references":[]}}
修改于 2025-11-10 02:57:26
上一页
Agent对话-信息收集
下一页
agent统计日志
Built with