POST
/
v1
/
chat
/
conversations
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/chat/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <api-key>' \
  --data '{
  "channel": "<string>",
  "tags": {},
  "integrationName": "<string>"
}'
{
  "conversation": {
    "id": "<string>",
    "currentTaskId": "<string>",
    "currentWorkflowId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "channel": "<string>",
    "integration": "<string>",
    "tags": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
x-bot-id
string
header
required

Your bot ID.

Body

application/json

Conversation data

​
channel
string
required

Channel name

Maximum length: 200
​
tags
object
required

Tags for the Conversation

​
integrationName
string
deprecated

[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.

Maximum length: 200

Response

Returns a Conversation object if creation succeeds. Returns an error otherwise

​
conversation
object
required

The Conversation object represents an exchange of messages between one or more users. A Conversation is always linked to an integration's channels. For example, a Slack channel represents a conversation.