tmp/harness-api.md

SE智能体相关接口

以下是对应 /harness 路由前缀的 SE 智能体 HTTP 接口文档。

开启一个会话窗口

• 请求地址：{gateway}/harness/session
• 请求方式：PUT

请求参数

参数名称	是否必传	类型	描述
username	是	String	用户名称

请求示例

curl -X PUT {gateway}/harness/session -H "Content-Type: application/json" -d '{
    "username": "zhangsan"
}'

响应参数

参数名称	类型	描述
code	Number	返回码（200=成功）
msg	String	提示信息
data	String	新开启的会话ID（sessionId）

成功示例

{
    "code": 200,
    "msg": "操作成功",
    "data": "1872639000000000001"
}

失败示例

{
    "code": 500,
    "msg": "错误信息"
}

查看聊天记录列表

• 请求地址：{gateway}/harness/session/history
• 请求方式：POST

请求参数

参数名称	是否必传	类型	描述
pageNum	否	Number	页码，默认1
pageSize	否	Number	每页行数，默认20
username	否	String	用户名，不传则从token获取
keywords	否	String	根据用户的问题去搜索

请求示例

curl -X POST {gateway}/harness/session/history -H "Content-Type: application/json" -d '{
    "pageNum": 1,
    "pageSize": 20,
    "username": "zhangsan",
    "keywords": "如何配置"
}'

响应参数

参数名称	类型	描述
total	Number	总记录数
rows	Array	会话列表数据
rows.sessionId	String	会话ID
rows.userQuestion	String	用户的第一个问题
rows.createTime	String	创建时间（yyyy-MM-dd HH:mm:ss）
rows.createAt	String	创建人
code	Number	返回码（200=成功）
msg	String	提示信息
extraData	Object	列表之外的额外数据

成功示例

{
    "total": 1,
    "rows": [
        {
            "sessionId": "1872639000000000001",
            "userQuestion": "如何配置聊天模型",
            "createTime": "2026-09-20 10:30:00",
            "createAt": "zhangsan"
        }
    ],
    "code": 200,
    "msg": "查询成功",
    "extraData": null
}

失败示例

{
    "code": 500,
    "msg": "错误信息"
}

查看会话聊天记录

• 请求地址：{gateway}/harness/session/message/{sessionId}
• 请求方式：GET

请求参数

参数名称	是否必传	类型	描述
sessionId	是	Number	会话ID

请求示例

curl -X GET {gateway}/harness/session/message/1872639000000000001

响应参数

参数名称	类型	描述
code	Number	返回码（200=成功）
msg	String	提示信息
data	Array	聊天消息列表
data.messageId	String	消息ID
data.messageType	String	消息类型（USER=用户输入，AGENT=智能体输出）
data.message	String	消息内容（markdown格式）
data.context	Object	扩展上下文信息
data.createTime	String	创建时间（yyyy-MM-dd HH:mm:ss）

成功示例

{
    "code": 200,
    "msg": "操作成功",
    "data": [
        {
            "messageId": "1872639000000001001",
            "messageType": "USER",
            "message": "你好，请问如何配置聊天模型？",
            "context": null,
            "createTime": "2026-09-20 10:30:00"
        },
        {
            "messageId": "1872639000000001002",
            "messageType": "AGENT",
            "message": "你好！配置聊天模型可以参考以下步骤：...",
            "context": null,
            "createTime": "2026-09-20 10:30:05"
        }
    ]
}

失败示例

{
    "code": 500,
    "msg": "错误信息"
}

预设的热门问题

• 请求地址：{gateway}/harness/hot/question
• 请求方式：GET

请求参数

无

请求示例

curl -X GET {gateway}/harness/hot/question

响应参数

参数名称	类型	描述
code	Number	返回码（200=成功）
msg	String	提示信息
data	Array	热门问题列表
data.questionShortName	String	热门问题简写
data.questionContent	String	问题实际内容

成功示例

{
    "code": 200,
    "msg": "操作成功",
    "data": [
        {
            "questionShortName": "如何配置模型",
            "questionContent": "如何为智能体配置聊天模型？"
        }
    ]
}

失败示例

{
    "code": 500,
    "msg": "错误信息"
}

预设的子智能体

• 请求地址：{gateway}/harness/subagent/config
• 请求方式：GET

请求参数

无

请求示例

curl -X GET {gateway}/harness/subagent/config

响应参数

参数名称	类型	描述
code	Number	返回码（200=成功）
msg	String	提示信息
data	Array	子智能体配置列表
data.name	String	子智能体名称
data.dataId	String	Nacos的配置文件ID

成功示例

{
    "code": 200,
    "msg": "操作成功",
    "data": [
        {
            "name": "代码助手",
            "dataId": "se-agent-code-helper"
        }
    ]
}

失败示例

{
    "code": 500,
    "msg": "错误信息"
}