主题
推送Assistant消息
介绍
推送消息到对话框 API 允许开发者向指定的会话中推送消息,主要用于在完成特定任务后提醒用户,从而可以继续进行对话。这个功能在自动化流程、任务提醒或状态更新通知等场景中非常有用。
基本信息
POST
https://ai-api.betteryeah.com/v1/oapi/agent/chat/push_msg
请求头
名称 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
Content-Type | string | true | 固定值 "application/json" | application/json |
Access-Key | string | true | 用于认证的访问密钥,获取参照:获取请求相关信息 | NjMyZDZlMTFkNGUxNGU2NjhmMGY5MWFlLDEwMDAsMTY5NTA5ODEwNjkwMA== |
Workspace-Id | string | true | 工作空间 ID,获取参照:获取请求相关信息 | 632d6e11d4e14e668f0f91ae |
示例
javascript
Content-Type:application/json
Access-Key:NjMyZDZlMTFkNGUxNGU2NjhmMGY5MWFlLDEwMDAsMTY5NTA5ODEwNjkwMA==
Workspace-Id:632d6e11d4e14e668f0f91ae
路径参数
名称 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
robot_id | string | true | agent的唯一标识符,获取参照:获取请求相关信息 | eaadc9531f0240d9beaf2bae98ea0e32 |
conversation_id | string | true | 会话 id | bc21a56c39b247e892541a69f56be3cc |
content | string | false | assistant消息内容 | “豆瓣关于孙子兵法的评论抓取已完成,请继续对话。” |
示例
javascript
curl --location 'https://ai-api.betteryeah.com/v1/oapi/agent/chat/push_msg' \
--header 'Content-Type: application/json' \
--header 'Access-Key: NjMyZDZlMTFkNGUxNGU2NjhmMGY5MWFlLDEwMDAsMTY5NTA5ODEwNjkwMA==' \
--header 'Workspace-Id: 632d6e11d4e14e668f0f91ae' \
--data '{
"robot_id": "eaadc9531f0240d9beaf2bae98ea0e32",
"conversation_id": "bc21a56c39b247e892541a69f56be3cc",
"content": "豆瓣关于孙子兵法的评论抓取已完成,请继续对话。"
}'
请求示例
javascript
curl --location 'https://ai-api.betteryeah.com/v1/oapi/agent/chat/history?robot_id=eaadc9531f0240d9beaf2bae98ea0e32&conversation_id=bc21a56c39b247e892541a69f56be3cc&id=1&page_size=20' \
--header 'Access-Key: NjMyZDZlMTFkNGUxNGU2NjhmMGY5MWFlLDEwMDAsMTY5NTA5ODEwNjkwMA==' \
--header 'Workspace-Id: 632d6e11d4e14e668f0f91ae'
响应
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
code | number | API响应的状态码 | 200|500等 |
success | boolean | API调用是否成功。true表示成功,而false表示失败。 | true|false |
message | string | API响应的状态消息 | "SUCCESS"或者"请求失败,原因 xxxx" |
data | object | 响应数据 | |
now_time | number | 服务器当前的时间戳(以秒为单位) |
响应示例
javascript
{
"code": 200,
"success": true,
"message": "SUCCESS",
"data": null,
"now_time": 1711040844
}