Skip to content

Read Flame AI settings

GET
/help-chat/settings
curl --request GET \
--url https://example.com/help-chat/settings \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Business-wide settings

Media typeapplication/json
object
businessDataEnabled
required
boolean

Example generated

{
"businessDataEnabled": true
}

Sign in required

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Session and membership required

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

An answer is already running

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Chat limit reached

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Help chat unavailable

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}