获取应用 WebApp 设置

适用于：Chatflow、Workflow、新 Agent、聊天助手、Agent、文本生成应用。

返回应用托管 WebApp 的品牌与展示设置，如标题、图标、主题色和默认语言。

GET /site

获取应用 WebApp 设置

cURL

curl --request GET \
  --url https://{api_base_url}/site \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/site"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/site', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/site",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/site"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{api_base_url}/site")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/site")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "title": "My Chat App",
  "chat_color_theme": "#4A90D9",
  "chat_color_theme_inverted": false,
  "icon_type": "emoji",
  "icon": "🤖",
  "icon_background": "#FFFFFF",
  "icon_url": null,
  "description": "一个有用的客服聊天机器人。",
  "copyright": "2025 Dify",
  "privacy_policy": "https://example.com/privacy",
  "input_placeholder": "有任何关于我们产品的问题都可以问我……",
  "custom_disclaimer": "",
  "default_language": "en-US",
  "show_workflow_steps": false,
  "use_icon_as_answer_icon": true
}

{
  "status": 403,
  "code": "forbidden",
  "message": "You don't have the permission to access the requested resource. It is either read-protected or not readable by the server."
}

Authorizations

Authorization · string · header · required

每个请求都通过 API Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401（unauthorized）。

Response

200

application/json

应用的 WebApp 设置。

title · string

WebApp 标题。

chat_color_theme · string

聊天主题颜色。

chat_color_theme_inverted · boolean

聊天主题颜色是否反转。

icon_type · string

使用的图标类型。emoji 为表情图标，image 为上传的图片图标。

icon · string

图标内容（表情或图片 ID）。

icon_background · string

图标背景颜色。

icon_url · string<url> | null

图标图片的 URL。

description · string

WebApp 描述。

copyright · string

版权文本。

privacy_policy · string

隐私政策 URL。

input_placeholder · string | null

WebApp 消息输入框中显示的占位文本。未配置时为 null。

custom_disclaimer · string

自定义免责声明文本。

default_language · string

默认语言代码。

show_workflow_steps · boolean

是否显示工作流步骤。

use_icon_as_answer_icon · boolean

是否使用应用图标作为回答图标。