打开会话 (Open Chat)
GET /chat/api/open - 根据智能体 ID 获取会话 ID
说明: 调用此接口将创建一个新的对话会话,返回会话 ID (chat_id)。后续发送消息需要使用此 ID。
发送对话消息 (Chat Message)
POST /api/maxkb/chat-message - 向指定会话发送消息
说明: 需要先通过"打开会话"接口获取 chat_id,或使用已有的 chat_id 发送消息。
必需,对话会话的唯一标识符
必需,要发送给 AI 的消息文本
默认值: true(非流式响应存在问题)
默认值: false
对话测试窗口
实时对话界面,可以连续发送消息测试 AI 回复
使用说明: 先获取会话 ID,然后在下方输入消息开始对话。支持 Enter 键快速发送。
请先在"打开会话"标签页获取会话 ID,然后在此输入消息开始对话
MaxKB 会话列表
GET /api/maxkb/sessions - 获取系统创建的所有 MaxKB 会话记录
说明: 展示系统创建的所有 MaxKB 会话记录,包括测试会话和正式会话。
智能体信息
GET /api/maxkb/application-profile - 获取当前配置的 MaxKB 智能体详细信息
说明: 展示当前配置的 MaxKB 智能体的详细信息,包括名称、描述、模型配置等。点击刷新按钮可重新获取最新信息。
MaxKB API 文档
MaxKB 对话接口参考文档
MaxKB 原始 API 接口
1. 打开会话
接口: GET /chat/api/open
说明: 根据智能体 ID 获取会话 ID
认证: Bearer Token (API Key)
响应示例:
{
"code": 200,
"data": "chat-session-uuid-here"
}
2. 发送消息
接口: POST /chat/api/chat_message/{chat_id}
说明: 向指定会话发送消息并获取 AI 回复
认证: Bearer Token (API Key)
请求体:
{
"message": "用户消息内容",
"stream": true,
"re_chat": false
}
响应示例:
{
"code": 200,
"data": {
"content": "AI 回复内容",
"is_end": true,
"chat_record_id": "记录 ID",
"message_tokens": 10,
"answer_tokens": 50
}
}
3. 获取智能体信息
接口: GET /chat/api/application/profile
说明: 获取智能体相关信息
认证: Bearer Token (API Key)
响应示例:
{
"code": 200,
"data": {
"id": "智能体 ID",
"name": "智能体名称",
"description": "智能体描述",
"model_id": "模型 ID"
}
}
后端代理 API 接口
以下接口由我们的后端服务器提供,内部调用 MaxKB 原始 API:
1. 打开会话 (代理)
接口: POST /api/maxkb/open-chat
说明: 调用 MaxKB 打开会话接口,返回会话 ID
认证: 需要登录 (Session)
响应示例:
{
"success": true,
"data": {
"chat_id": "chat-session-uuid-here"
}
}
2. 发送消息 (代理)
接口: POST /api/maxkb/chat-message
说明: 调用 MaxKB 发送消息接口
认证: 需要登录 (Session)
请求体:
{
"chat_id": "会话 ID",
"message": "用户消息内容",
"stream": true,
"re_chat": false
}
响应示例:
{
"success": true,
"data": {
"content": "AI 回复内容",
"raw": { ... }
}
}
3. 获取智能体信息 (代理)
接口: GET /api/maxkb/application-profile
说明: 调用 MaxKB 获取智能体信息接口
认证: 需要登录 (Session)
响应示例:
{
"success": true,
"data": {
"id": "智能体 ID",
"name": "智能体名称",
"description": "智能体描述"
}
}