POST
/
v3
/
sessions
Start Session
curl --request POST \
  --url http://127.0.0.1:3333/v3/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "botId": "<string>"
}
'
{
  "result": {
    "id": "<string>",
    "isCompleted": true
  },
  "resultId": "<string>",
  "sessionId": "<string>",
  "bot": "<unknown>",
  "messages": [
    "<unknown>"
  ],
  "input": "<unknown>",
  "dynamicTheme": "<unknown>",
  "logs": [
    "<unknown>"
  ],
  "clientSideActions": [
    "<unknown>"
  ],
  "hasReachedLimit": true,
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
botId
string
required
bot
any
isPreview
boolean
channel
enum<string>
default:web
Available options:
web,
api,
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
required
resultId
string
sessionId
string
bot
any
messages
any[]
input
any
dynamicTheme
any
logs
any[]
clientSideActions
any[]
hasReachedLimit
boolean
error
string