POST
Start Session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
botId
string
bot
any
previewToken
string
sessionId
string
isPreview
boolean
channel
enum<string>
default:web
Available options:
web,
api,
whatsapp,
instagram,
facebook,
telegram,
gmail,
tiktok
prefilledVariables
object
resultId
string
isStreamEnabled
boolean
isOnlyRegistering
boolean
textBubbleContentFormat
enum<string>
default:richText
Available options:
richText,
markdown
startFrom
any
message
any
origin
string
iframeReferrerOrigin
string

Response

Default Response

result
object | null
required
resultId
string
sessionId
string
bot
any
messages
any[]
input
any
lastMessageNewFormat
string
dynamicTheme
any
logs
any[]
clientSideActions
any[]
progress
number
hasReachedLimit
boolean
error
string