主题
创建新会话
介绍
此 API 用于创建一个新的会话。需要提供 robot_id、用户信息、会话标题和。请求成功时,通常会返回新创建会话的详细信息,包括会话 ID 和其他相关数据。
基本信息
POST
https://ai-api.betteryeah.com/v1/oapi/agent/chat/conversation/create
请求头
名称 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
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 |
user | string | true | 用户名,标识用户信息 | zhangsan |
title | string | true | 会话标题 | 如何学习孙子兵法 |
示例
javascript
{
"robot_id": "eaadc9531f0240d9beaf2bae98ea0e32",
"user": "zhangsan",
"title": "如何学习孙子兵法"
}
请求示例
javascript
curl --location 'https://ai-api.betteryeah.com/v1/oapi/agent/chat/conversation/create' \
--header 'Content-Type: application/json' \
--header 'Access-Key: NjMyZDZlMTFkNGUxNGU2NjhmMGY5MWFlLDEwMDAsMTY5NTA5ODEwNjkwMA==' \
--header 'Workspace-Id: 632d6e11d4e14e668f0f91ae' \
--data '{
"robot_id": "eaadc9531f0240d9beaf2bae98ea0e32",
"user": "zhangsan",
"title": "如何学习孙子兵法"
}'
响应
名称 | 类型 | 描述 | 示例 | |
---|---|---|---|---|
code | number | API响应的状态码 | 200|500等 | |
success | boolean | API调用是否成功。true表示成功,而false表示失败。 | true|false | |
message | string | API响应的状态消息 | ||
data | object | API 响应数据 | ||
conversation_id | string | 会话 id | e63fb7c8b047418c84a737c7556a7f3e | |
title | string | 会话标题 | 如何学习孙子兵法 | |
robot_id | int | agent_id,agent 唯一标识 | eaadc9531f0240d9beaf2bae98ea0e32 | |
update_time | string | 更新时间 | 2024-03-20T16:14:25.643519 | |
session_id | string | 对话 id | 42c50250bfb4490a96c3cc4d56142130 | |
now_time | number | 服务器当前的时间戳(以秒为单位) |
响应示例
javascript
{
"code": 200,
"success": true,
"message": "SUCCESS",
"data": {
"conversation_id": "e63fb7c8b047418c84a737c7556a7f3e",
"uid": -1000,
"title": "如何学习孙子兵法",
"robot_id": "eaadc9531f0240d9beaf2bae98ea0e32",
"update_time": "2024-03-20T16:14:25.643519",
"session_id": "42c50250bfb4490a96c3cc4d56142130"
},
"now_time": 1710922465
}