Start Preview Chat

Endpoint used to start a preview chat session in Toolzz Bots.

Request Example

curl --request POST \
  --url 'https://bots-viewer.toolzz.ai/api/v1/typebots/{typebotId}/preview/startChat' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response Example

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

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (must contain “Bearer” before the token)	Yes

URL Parameters (Path)

Parameter	Type	Description	Required
typebotId	string	The public ID of the bot to start a preview chat for.	Yes

---

Response description

Key	Type	Description
sessionId	string	Unique identifier of the preview session.
typebot	object	The bot information.
typebot.id	string	Unique identifier for the bot.
typebot.theme	any	The visual appearance information of the bot.
typebot.settings	any	The pre-set configuration of the bot.
messages	object[]	The messages content and information in the bot session.
messages[].id	string	Unique identifier for the message of the session.
messages[].type	string	The format of the message sent.
messages[].content	any	The content of the message sent.
input	object	The bot input information.
input.id	string	Unique identifier for the input of the session.
input.outgoingEdgeId	string	Unique identifier of the edge that leads out from a specific input block in the bot flow.
input.type	string	The type of content sent.
input.options	object	The input options.
input.options.variableId	object	The unique identifier of the variable that will store the user’s selection.

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request.