POST
/
v1
/
typebots
/
{publicId}
/
startChat

Path Parameters

publicId
string
required

Where to find my bot's public ID?

Body

application/json
message
object

Only provide it if your flow starts with an input block and you'd like to directly provide an answer to it.

isStreamEnabled
boolean
default: false

If enabled, you will be required to stream OpenAI completions on a client and send the generated response back to the API.

resultId
string

Provide it if you'd like to overwrite an existing result.

isOnlyRegistering
boolean
default: false

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.

prefilledVariables
object

More info about prefilled variables.

textBubbleContentFormat
enum<string>
default: richText
Available options:
richText,
markdown

Response

200 - application/json
sessionId
string
required

To save and use for /continueChat requests.

typebot
object
required
messages
object[]
required
resultId
string
lastMessageNewFormat
string

The 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.

input
object
clientSideActions
object[]

Actions to execute on the client side

logs
object[]

Logs that were saved during the last execution

dynamicTheme
object

If the typebot contains dynamic avatars, dynamicTheme returns the new avatar URLs whenever their variables are updated.

progress
number

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.

How-toStart preview chat