Chat
Start preview chat
Get started
Chat
Typebot
Analytics
Workspace
Chat
Start preview chat
Use this endpoint to test your bot. The answers will not be saved. And some blocks like “Send email” will be skipped.
POST
/
v1
/
typebots
/
{typebotId}
/
preview
/
startChat
typebotId
string
*
typebotId
Required
string
object
*
isStreamEnabled
boolean
isStreamEnabled
boolean
message
object
message
object
type
enum<string>
*
type
Required
enum<string>
text
string
*
text
Required
string
attachedFileUrls
array
attachedFileUrls
array
Can only be provided if current input block is a text input block that allows attachments
isOnlyRegistering
boolean
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
Typebot V5 · object
typebot
object
If set, it will override the typebot that is used to start the chat.
version
enum<string>
*
version
Required
enum<string>
id
string
*
id
Required
string
groups
array
*
groups
Required
array
events
array
*
events
Required
array
edges
array
*
edges
Required
array
variables
array
*
variables
Required
array
settings
object
*
settings
Required
object
general
object
general
object
isBrandingEnabled
boolean
isBrandingEnabled
boolean
isTypingEmulationEnabled
boolean
isTypingEmulationEnabled
boolean
isInputPrefillEnabled
boolean
isInputPrefillEnabled
boolean
isHideQueryParamsEnabled
boolean
isHideQueryParamsEnabled
boolean
isNewResultOnRefreshEnabled
boolean
isNewResultOnRefreshEnabled
boolean
rememberUser
object
rememberUser
object
typingEmulation
object
typingEmulation
object
enabled
boolean
enabled
boolean
speed
number
speed
number
maxDelay
number
maxDelay
number
delayBetweenBubbles
number
delayBetweenBubbles
number
isDisabledOnFirstMessage
boolean
isDisabledOnFirstMessage
boolean
metadata
object
metadata
object
title
string
title
string
description
string
description
string
imageUrl
string
imageUrl
string
favIconUrl
string
favIconUrl
string
customHeadCode
string
customHeadCode
string
googleTagManagerId
string
googleTagManagerId
string
whatsApp
object
whatsApp
object
isEnabled
boolean
isEnabled
boolean
startCondition
object
startCondition
object
sessionExpiryTimeout
number
sessionExpiryTimeout
number
Expiration delay in hours after latest interaction
publicShare
object
publicShare
object
isEnabled
boolean
isEnabled
boolean
security
object
security
object
allowedOrigins
array
allowedOrigins
array
theme
object
*
theme
Required
object
general
object
general
object
font
Option 1 · string
font
string
background
object
background
object
progressBar
object
progressBar
object
chat
object
chat
object
container
object
container
object
hostAvatar
object
hostAvatar
object
guestAvatar
object
guestAvatar
object
hostBubbles
object
hostBubbles
object
guestBubbles
object
guestBubbles
object
buttons
object
buttons
object
inputs
object
inputs
object
roundness
enum<string>
roundness
enum<string>
Deprecated, use container.border.roundeness instead
customCss
string
customCss
string
startFrom
Option 1 · object
startFrom
object
type
enum<string>
*
type
Required
enum<string>
groupId
string
*
groupId
Required
string
prefilledVariables
object
prefilledVariables
object
Add Example Value
sessionId
string
sessionId
string
If provided, will be used as the session ID and will overwrite any existing session with the same ID.
textBubbleContentFormat
enum<string>
textBubbleContentFormat
enum<string>
Path Parameters
Body
application/json
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.
If set, it will override the typebot that is used to start the chat.
Available options:
3, 4, 5 Expiration delay in hours after latest interaction
Required range:
0.01 < x < 48Available options:
Top, Bottom Available options:
fixed, absolute Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Deprecated, use container.border.roundeness instead
Available options:
none, medium, large If provided, will be used as the session ID and will overwrite any existing session with the same ID.
Available options:
richText, markdown Response
200 - application/json
To save and use for /continueChat requests.
Available options:
Top, Bottom Available options:
fixed, absolute Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Deprecated, use container.border.roundeness instead
Available options:
none, medium, large Expiration delay in hours after latest interaction
Required range:
0.01 < x < 48The sent message is validated and formatted on the backend. For example, if for a date input you replied something like tomorrow, the backend will convert it to a date string. This field returns the formatted message.
Available options:
text input Actions to execute on the client side
Available options:
scriptToExecute If progress bar is enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the flow.