POST
/
api
/
v1
/
typebots
/
{sessionId}
/
preview
/
startChat
Start Preview Chat
curl --request POST \
  --url https://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat \
  --header 'Authorization: Bearer <token>'
{
  "sessionId": "<string>",
  "typebot": {
    "id": "<string>",
    "theme": "<any>",
    "settings": "<any>"
  },
  "messages": [
    {
      "id": "<string>",
      "type": "<string>",
      "content": "<any>"
    }
  ],
  "input": {
    "id": "<string>",
    "outgoingEdgeId": "<string>",
    "type": "<string>",
    "options": "<string>"
  }
}

Parameters

typebotId
string
typebotId: The public ID of the bot to start a preview chat for.

Response Description

Below you will see the description of the function start preview chat.
sessionId
string
required
Unique identifier of the preview session.
typebot
object
required
The Bot information setted.
messages
object[]
required
The messages content and information in the bot session.
input
object{}
required
The bot input informations.