> 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/en/api-integration/endpoint-behaviors/branding-api.md).

# Site Branding Configuration API

Explains how integrations can retrieve public branding display settings based on a site's domain.

When a single backend serves sites for different brands, pages shown before login need to know each site's name, images, and links. Integrations can call `GET /api/branding/` through the **current site's domain** to retrieve its public display settings. This read endpoint does not require login.

## Read and apply settings <a href="#read-and-apply" id="read-and-apply"></a>

1. Send `GET /api/branding/` through the domain that serves the site. The request's Host determines the brand; a user, organization ID, or query parameter does not select it.
2. Read the display fields you need from the response. For example, use `siteName` for the site name, `logoFullUrl` for the full logo, and `primaryColor` for the primary color.
3. If a field is `null`, hide the corresponding element; do not substitute default assets from another brand. If the domain has no dedicated configuration, the service first uses the system's default brand. If there is no default brand either, every field is `null`.

{% hint style="info" %}
If your integration uses a reverse proxy, make sure the Host forwarded to the API remains the domain of the site whose brand you want to display. Calling the API directly through a shared API domain returns the brand associated with that API domain or the system's default brand.
{% endhint %}

## Response fields <a href="#response-fields" id="response-fields"></a>

HTTP 200 returns a JSON object with camelCase fields:

| Purpose    | Fields                                                                                          |
| ---------- | ----------------------------------------------------------------------------------------------- |
| Text       | `siteName`, `assistantName`, `supportEmail`, `poweredByText`                                    |
| Image URLs | `faviconUrl`, `logoMarkUrl`, `logoFullUrl`, `logoAnimatedUrl`, `assistantIconUrl`, `ogImageUrl` |
| Colors     | `primaryColor`, `splashBackgroundColor`, `splashTextColor`, `progressBarColor`                  |
| Links      | `docsUrl`, `termsUrl`, `privacyUrl`, `loginRedirectUrl`                                         |

Every field may be `null`. Image fields contain URLs ready for display; use the values returned by the API directly instead of constructing media paths yourself.


---

# 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/en/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.