アプリの WebApp 設定を取得

対象アプリ：Chatflow、Workflow、チャットボット、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",
  "custom_disclaimer": "",
  "default_language": "en-US",
  "show_workflow_steps": false,
  "use_icon_as_answer_icon": true
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Forbidden."
}

Authorizations

Authorization · string · header · required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。API 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。

custom_disclaimer · string

カスタム免責事項テキスト。

default_language · string

デフォルト言語コード。

show_workflow_steps · boolean

ワークフローステップを表示するかどうか。

use_icon_as_answer_icon · boolean

アプリアイコンを回答アイコンとして使用するかどうか。