Skip to main content

Start preview chat

Start preview chat

Path Parameters
typebotId string REQUIRED
Request Body REQUIRED
isStreamEnabled boolean
message string
isOnlyRegistering boolean

If set to true, it will only register the session and not start the bot. This is used for 3rd party chat platforms as it can require a session to be registered before sending the first message.

typebot

If set, it will override the typebot that is used to start the chat.

startFrom
Responses
200

Successful response

Schema
lastMessageNewFormat string

The sent message is validated and formatted on the backend. This is set only if the message differs from the formatted version.

messages object[]
id string
input object
prefilledValue string
runtimeOptions object
paymentIntentSecret string
amountLabel string
publicKey string
clientSideActions object[]
lastBubbleBlockId string
expectsDedicatedReply boolean
logs object[]
status string
description string
details
dynamicTheme object
hostAvatarUrl string
guestAvatarUrl string
sessionId string
typebot object
id string
theme
settings
default

Error response

Schema
message string
code string
issues object[]
message string