Skip to main content
get/site
Request example
Response
get/site

Authorization

Authorizationstringheaderrequired#

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).

Responses

application/json
Web app settings of the application.
chat_color_themestring#
Chat color theme.
chat_color_theme_invertedboolean#
Whether the chat color theme is inverted.
custom_disclaimerstring#
Custom disclaimer text.
default_languagestring#
Default language code.
descriptionstring#
Web app description.
iconstring#
Icon content (emoji or image ID).
icon_backgroundstring#
Icon background color.
icon_typestring#
Type of icon used. emoji for emoji icons, image for uploaded image icons.
icon_urlstring#
URL of the icon image.
input_placeholderstring#
Placeholder text shown in the web app message input box. null when not configured.
privacy_policystring#
Privacy policy URL.
show_workflow_stepsboolean#
Whether to show workflow steps.
titlestring#
Web app title.
use_icon_as_answer_iconboolean#
Whether to use the app icon as the answer icon.