createConversation

Creates a new Conversation

POST/conversations

Header parameters

x-user-keystringrequired

Authentication Key

Request body

Conversation data

idstring

Identifier of the Conversation

Response

application/json

Returns a Conversation

The response is of type createConversationResponse · object.

conversationobjectrequired

Request

curl --request POST \ \
  --url https://chat.botpress.cloud/your_default_webhook_url/conversations \
  --header 'x-user-key: <x-user-key>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": ""
}
'

Response

{
  "conversation": {
    "id": "string",
    "createdAt": "2025-01-15T12:00:00Z",
    "updatedAt": "2025-01-15T12:00:00Z"
  }
}