Skip to main content
GET
/
site
Error
A valid request URL is required to generate request examples
{
  "title": "<string>",
  "chat_color_theme": "<string>",
  "chat_color_theme_inverted": true,
  "icon_type": "emoji",
  "icon": "<string>",
  "icon_background": "<string>",
  "icon_url": "<string>",
  "description": "<string>",
  "copyright": "<string>",
  "privacy_policy": "<string>",
  "custom_disclaimer": "<string>",
  "default_language": "<string>",
  "show_workflow_steps": true,
  "use_icon_as_answer_icon": true
}

Authorizations

​
Authorization
string
header
required

API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。

Response

200 - application/json

WebApp 设置信息。

应用 WebApp 设置。

​
title
string

WebApp 名称。

​
chat_color_theme
string

聊天颜色主题, hex 格式。

​
chat_color_theme_inverted
boolean

聊天颜色主题是否反转。

​
icon_type
enum<string>

图标类型。

Available options:
emoji,
image
​
icon
string

图标内容 (emoji 或图片 URL)。

​
icon_background
string

hex 格式的背景色。

​
icon_url
string<url> | null

图标 URL。

​
description
string

描述。

​
copyright
string

版权信息。

​
privacy_policy
string

隐私政策链接。

​
custom_disclaimer
string

自定义免责声明。

​
default_language
string

默认语言。

​
show_workflow_steps
boolean

是否显示工作流详情。

​
use_icon_as_answer_icon
boolean

是否使用 WebApp 图标替换聊天中的机器人图标。