Skip to main content
GET
/
site
{
  "title": "My App",
  "chat_color_theme": "#ff4a4a",
  "chat_color_theme_inverted": false,
  "icon_type": "emoji",
  "icon": "😄",
  "icon_background": "#FFEAD5",
  "icon_url": null,
  "description": "This is my app.",
  "copyright": "all rights reserved",
  "privacy_policy": "",
  "custom_disclaimer": "All generated by AI",
  "default_language": "en-US",
  "show_workflow_steps": false,
  "use_icon_as_answer_icon": false
}

Authorizations

Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with 'Bearer '. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Response

200 - application/json

WebApp settings of the application.

title
string

WebApp name.

chat_color_theme
string

Chat color theme, in hex format (e.g., #RRGGBB).

chat_color_theme_inverted
boolean

Whether the chat color theme is inverted.

icon_type
enum<string>

Icon type.

Available options:
emoji,
image
icon
string

Icon. If it's emoji type, it's an emoji symbol; if it's image type, it's an image URL.

icon_background
string

Background color in hex format (e.g., #RRGGBB).

icon_url
string<url> | null

Icon URL (likely refers to image type if icon field is just a name/id).

description
string

Description.

Copyright information.

privacy_policy
string

Privacy policy link.

custom_disclaimer
string

Custom disclaimer.

default_language
string

Default language (e.g., en-US).

show_workflow_steps
boolean

Whether to show workflow details.

use_icon_as_answer_icon
boolean

Whether to replace 🤖 in chat with the WebApp icon.