v1

latestOpenAPI 3.1.12026-07-263397525.2 KB
Chat

Start chat

post/v1/typebots/{publicId}/startChat

Path parameters

publicIdstring required

Where to find my bot's public ID?

Request body

resultIdstring

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

isStreamEnabledboolean

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

isOnlyRegisteringboolean

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.

prefilledVariablesobject

More info about prefilled variables.

textBubbleContentFormat'richText' | 'markdown'

Response

OK

sessionIdstring required

To save and use for /continueChat requests.

resultIdstring
lastMessageNewFormatstring

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.

progressnumber

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.