> For the complete documentation index, see [llms.txt](https://docs.maiagent.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.maiagent.ai/tech/api-integration/endpoint-behaviors/branding-api.md).

# 站台品牌設定 API

說明整合端如何依站台網域取得公開品牌顯示設定。

同一個後端服務不同品牌站台時，登入前的頁面也需要知道站台名稱、圖像與連結。整合端可從**目前站台的網域**呼叫 `GET /api/branding/`，取得該站台的公開顯示設定。這個讀取端點不需要登入。

## 讀取與套用 <a href="#read-and-apply" id="read-and-apply"></a>

1. 透過服務該站台的網域送出 `GET /api/branding/`。品牌由請求的 Host 決定，不是由使用者、組織 ID 或查詢參數選擇。
2. 從回應讀取需要的顯示欄位。例如 `siteName` 用於站台名稱，`logoFullUrl` 用於完整標誌，`primaryColor` 用於主色。
3. 欄位為 `null` 時，隱藏對應元素；不要自行填入其他品牌的預設素材。若網域沒有專屬設定，服務會先使用系統預設品牌；連預設品牌也沒有時，所有欄位均為 `null`。

{% hint style="info" %}
若整合端經過反向代理，請確認轉送至 API 的 Host 仍是要顯示品牌的站台網域。以共用 API 網域直接呼叫，取得的是該 API 網域對應的品牌或系統預設品牌。
{% endhint %}

## 回應欄位 <a href="#response-fields" id="response-fields"></a>

HTTP 200 回傳 JSON 物件，欄位採 camelCase：

| 用途     | 欄位                                                                                         |
| ------ | ------------------------------------------------------------------------------------------ |
| 文字     | `siteName`、`assistantName`、`supportEmail`、`poweredByText`                                  |
| 圖像 URL | `faviconUrl`、`logoMarkUrl`、`logoFullUrl`、`logoAnimatedUrl`、`assistantIconUrl`、`ogImageUrl` |
| 顏色     | `primaryColor`、`splashBackgroundColor`、`splashTextColor`、`progressBarColor`                |
| 連結     | `docsUrl`、`termsUrl`、`privacyUrl`、`loginRedirectUrl`                                       |

所有欄位都可能是 `null`。圖像欄位是可供顯示的 URL；整合端應直接使用回應值，不要自行組合媒體路徑。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.maiagent.ai/tech/api-integration/endpoint-behaviors/branding-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.