Start Chat

Endpoint to start a chat

POST /api/v1/typebots/{publicId}/startChat

Start Chat

cURL

curl --request POST \
  --url https://bots-viewer.toolzz.ai/api/v1/typebots/{publicId}/startChat

200

{
  "sessionId": "<string>",
  "resultId": "<string>",
  "typebot": [
    "<any>"
  ],
  "messages": [
    {
      "id": "<string>",
      "type": "<string>",
      "content": "<any>"
    }
  ],
  "input": {
    "id": "<string>",
    "outgoingEdgeId": "<string>",
    "type": "<string>",
    "options": "<string>"
  }
}

Parameters

publicId · string

publicId: The public ID of the bot to start a chat for.

Response Description

Below you will see the description of the function start chat.

sessionId · string · required

Unique identifier of the created session.

resultId · string · required

Unique identifier assigned to each individual response.

typebot · any[] · required

Information of the bot it self.

Show typebot properties

id · string · required

Unique identifier for bot.

theme · any

The visual appearance information of the bot.

settings · any

The pre settings information of the bot.

messages · object[] · required

The messages content and information in the bot session.

Show messages properties

id · string · required

Unique identifier for the messages of the session.

type · string

The format of the message sent.

content · any

The content of the message sent.

input · object{} · required

The bot input informations.

Show input properties

id · string · required

Unique identifier for the inputs of the session.

outgoingEdgeId · string

Unique identifier of the edge that leads out from a specific input block in your bot flow.

type · string

The type of content sent.

options · string

The type of content sent.

Show options properties

variableId · string

The unique identifier of the variable that will store the user’s selection from those options.