Create Conversation

Used to request and get a conversation ID. The conversation ID is the basic carrier for users to chat with the Bot. Capabilities like chat history, long-term memory, and short-term memory are all based on the conversation ID.

Request Method

POST

Request URL

https://api.gptbots.ai/v1/conversation

Request Authentication

See Overview for authentication details.

Request

Request Example

curl -X POST https://api.gptbots.ai/v1/conversation \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json' \ -d '{ "user_id": "123456789" }'

          curl -X POST https://api.gptbots.ai/v1/conversation \
  -H 'Authorization: Bearer your_apikey' \
  -H 'Content-Type: application/json' \
  -d '{
        "user_id": "123456789"
}'

This code block in the floating window

Request Headers

Field	Type	Description
Authorization	Bearer ${token}	Use Authorization: Bearer ${token} for authentication. Get the key from the API Keys page as token.
Content-Type	application/json	Data type, set to application/json.

Request Body

Field	Type	Required	Description
user_id	string	Yes	User ID defined by developer to uniquely identify a user in the Bot. Max length 32 chars.

Response

Response Example

{ "conversation_id": "657303a8a764d47094874bbe" }

          {
  "conversation_id": "657303a8a764d47094874bbe" 
}

This code block in the floating window

Success Response

Field	Type	Description
conversation_id	string	Conversation identifier.

Failure Response

Field	Type	Description
code	int	Error code.
message	string	Error details.

Error Codes

Code	Message
40000	Parameter error
40127	Developer authentication failed
40378	Bot deleted