创建对话ID

用于请求创建并获取一个conversation_id，该 ID 是用户与Agent进行对话的标识符ID。用户属性、长期记忆和短期记忆等都从属于conversation_id。

ID 名称	描述
conversation_id	由`agent_id`和`user_id`共同生成的对话标识符ID，用来承载用户与Agent的一次多轮对话。一个`conversation_id`通常存在着多条`message_id`。
message_id	由`用户发送消息`和`Agent回复消息`共同生成的消息标识符ID，代表着用户与Agent的一轮对话。`message_id` 必定从属于 `conversation_id`。

请求方式

POST

调用地址

https://api-${endpoint}.gptbots.ai/v1/conversation

调用验证

详情参见 API 概述的鉴权方式说明。

请求

请求示例

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "user_id": "your_user_id" }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
        "user_id": "your_user_id"
}'

此代码块在浮窗中显示

请求头

字段	类型	描述
Authorization	Bearer ${API Key}	使用`Authorization: Bearer ${API Key}`进行调用验证，请在 API 密钥页面获取密钥作为`API Key`。
Content-Type	application/json	数据类型，取值为 application/json。

请求参数

字段	类型	必填	描述
user_id	string	是	用户标识，开发者需为终端用户定义一个 user_id，在 Agent 内唯一识别一个用户。最长 32 字符。

响应

响应示例

{ "conversation_id": "657303a8a764d47094874bbe" }

                      
                      {
  "conversation_id": "657303a8a764d47094874bbe"
}

此代码块在浮窗中显示

成功响应

字段	类型	描述
conversation_id	string	对话标识符。

失败响应

字段	类型	描述
code	int	错误码。
message	string	错误详情。

错误码

Code	Message
40000	参数错误
40127	开发者鉴权失败
40378	Agent 已删除