Skip to main content
GET
Get App WebApp Settings

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Response

WebApp settings of the application.

title
string

WebApp title.

chat_color_theme
string

Chat color theme.

chat_color_theme_inverted
boolean

Whether the chat color theme is inverted.

icon_type
string

Type of icon used. emoji for emoji icons, image for uploaded image icons.

icon
string

Icon content (emoji or image ID).

icon_background
string

Icon background color.

icon_url
string<url> | null

URL of the icon image.

description
string

WebApp description.

Copyright text.

privacy_policy
string

Privacy policy URL.

custom_disclaimer
string

Custom disclaimer text.

default_language
string

Default language code.

show_workflow_steps
boolean

Whether to show workflow steps.

use_icon_as_answer_icon
boolean

Whether to use the app icon as the answer icon.