Skip to main content
POST
Create conversation

Body

application/json
publicId
string
required

Published bot's public ID. Where to find it?

message
object
prefilledVariables
object
Example:
conversationId
string

Resume an existing conversation instead of starting a new one.

Response

Successful response

bot
object
required
actor
object
required
messages
(Text · object | Image · object | Video · object | Audio · object | Embed · object)[]
required
conversationId
string
input
Text · object
clientSideActions
(Script to execute · object | Redirect · object | Wait · object | Set variable · object | Inject start props · object | Execute code · object)[]

Actions to execute on the client side

logs
object[]

Logs that were saved during the last execution

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.

guestDisplayText
string