创建对话
最新更新:2024-07-23
创建对话
用于请求创建并获取一个对话ID(conversation ID),对话 ID 是用户与 Bot 进行聊天的基础载体。聊天记录、长期记忆和短期记忆等能力都是基于对话 ID。
请求方式
POST
调用地址
https://api.gptbots.ai/v1/conversation
调用验证
详情参见【API 概述】内的鉴权方式说明。
请求
请求示例
curl -X POST https://api.gptbots.ai/v1/conversation \
-H 'Authorization: Bearer your_apikey' \
-H 'Content-Type: application/json' \
-d '{
"user_id": "your_user_id"
}'
curl -X POST https://api.gptbots.ai/v1/conversation \
-H 'Authorization: Bearer your_apikey' \
-H 'Content-Type: application/json' \
-d '{
"user_id": "your_user_id"
}'
此代碼塊在浮窗中顯示
请求头
字段 | 类型 | 描述 |
---|---|---|
Authorization | Bearer ${token} | 使用 Authorization: Bearer ${token}进行调用验证,请在 API 密钥页面获取密钥作为 token。 |
Content-Type | application/json | 数据类型,取值为 application/json。 |
请求体
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
user_id | string | 是 | 用户标识,开发者需为终端用户定义一个 user_id,在 Bot 内唯一识别一个用户。最长 32 字符。 |
响应
响应示例
{
"conversation_id": "657303a8a764d47094874bbe"
}
{
"conversation_id": "657303a8a764d47094874bbe"
}
此代碼塊在浮窗中顯示
成功响应
字段 | 类型 | 描述 |
---|---|---|
conversation_id | string | 对话标识符。 |
失败响应
字段 | 类型 | 描述 |
---|---|---|
code | int | 错误码。 |
message | string | 错误详情。 |
错误码
Code | Message |
---|---|
40000 | 参数错误 |
40127 | 开发者鉴权失败 |
40378 | Bot 已删除 |