Typebot
Create a typebot
Typebot
Create a typebot
POST
/
v1
/
typebots
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
object
*
workspaceId
string
*
workspaceId
Required
string
typebot
object
*
typebot
Required
object
name
string
name
string
icon
string
icon
string
selectedThemeTemplateId
string
selectedThemeTemplateId
string
groups
array
groups
array
events
array
events
array
theme
object
theme
object
general
object
general
object
font
Option 1 · string
font
string
background
object
background
object
progressBar
object
progressBar
object
chat
object
chat
object
container
object
container
object
hostAvatar
object
hostAvatar
object
guestAvatar
object
guestAvatar
object
hostBubbles
object
hostBubbles
object
guestBubbles
object
guestBubbles
object
buttons
object
buttons
object
inputs
object
inputs
object
roundness
enum<string>
roundness
enum<string>
Deprecated, use container.border.roundeness instead
customCss
string
customCss
string
settings
object
settings
object
general
object
general
object
isBrandingEnabled
boolean
isBrandingEnabled
boolean
isTypingEmulationEnabled
boolean
isTypingEmulationEnabled
boolean
isInputPrefillEnabled
boolean
isInputPrefillEnabled
boolean
isHideQueryParamsEnabled
boolean
isHideQueryParamsEnabled
boolean
isNewResultOnRefreshEnabled
boolean
isNewResultOnRefreshEnabled
boolean
rememberUser
object
rememberUser
object
typingEmulation
object
typingEmulation
object
enabled
boolean
enabled
boolean
speed
number
speed
number
maxDelay
number
maxDelay
number
delayBetweenBubbles
number
delayBetweenBubbles
number
isDisabledOnFirstMessage
boolean
isDisabledOnFirstMessage
boolean
metadata
object
metadata
object
title
string
title
string
description
string
description
string
imageUrl
string
imageUrl
string
favIconUrl
string
favIconUrl
string
customHeadCode
string
customHeadCode
string
googleTagManagerId
string
googleTagManagerId
string
whatsApp
object
whatsApp
object
isEnabled
boolean
isEnabled
boolean
startCondition
object
startCondition
object
sessionExpiryTimeout
number
sessionExpiryTimeout
number
Expiration delay in hours after latest interaction
publicShare
object
publicShare
object
isEnabled
boolean
isEnabled
boolean
security
object
security
object
allowedOrigins
array
allowedOrigins
array
folderId
string
folderId
string
variables
array
variables
array
edges
array
edges
array
resultsTablePreferences
object
resultsTablePreferences
object
columnsOrder
array
*
columnsOrder
Required
array
columnsVisibility
object
*
columnsVisibility
Required
object
columnsWidth
object
*
columnsWidth
Required
object
publicId
string
publicId
string
customDomain
string
customDomain
string
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Available options:
Top, Bottom Available options:
fixed, absolute Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Deprecated, use container.border.roundeness instead
Available options:
none, medium, large Expiration delay in hours after latest interaction
Required range:
0.01 < x < 48Response
200 - application/json
Available options:
6 Available options:
Top, Bottom Available options:
fixed, absolute Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Required range:
0 < x < 1Available options:
none, sm, md, lg, xl, 2xl Deprecated, use container.border.roundeness instead
Available options:
none, medium, large Expiration delay in hours after latest interaction
Required range:
0.01 < x < 48