Skip to content

InstanceBrandImage

A brand image that the administrators set: the sanitized SVG and its PNG renditions, at URLs under /brand/ on the server that name the revision, so their content never changes and they may be cached for good. Show the SVG only as an image (<img> or a CSS background), never inline. Instance has the icon, the logo (a wordmark that includes the instance’s name, which clients show instead of the name), and the logo_dark for dark backgrounds (logo is used there without it); each is omitted while the instance uses the built-in image.

object
revision
required
string
svg_url
required
string format: uri
width
required

The width of the SVG’s viewBox, rounded.

integer
>= 1
height
required

The height of the SVG’s viewBox, rounded.

integer
>= 1
renditions
required
Array<object>

A PNG rendition of a brand image, served at a URL whose content never changes.

object
rendition
required

A PNG rendition of a brand image, drawn from its SVG for the places that take no SVG: favicon-32 and favicon-48 (32 and 48 pixels), apple-touch-180 (180 pixels, opaque, the iOS home screen), pwa-192 and pwa-512 (the app icons), and maskable-512 (512 pixels, opaque, the mark within the middle 80%) of the icon; logo-mail of the logo and logo-dark-mail of the dark logo (96 pixels high and as wide as the aspect ratio makes it, up to 600 pixels, which then sets the height; a pixel off is accepted), shown in emails; and preview-1200x630 of the logo (1200 × 630 pixels, opaque), the link preview image when the instance has no preview_image.

string
Allowed values: favicon-32 favicon-48 apple-touch-180 pwa-192 pwa-512 maskable-512 logo-mail logo-dark-mail preview-1200x630
url
required
string format: uri
width
required
integer
>= 1
height
required
integer
>= 1

Example generated

{
"revision": "example",
"svg_url": "https://example.com",
"width": 1,
"height": 1,
"renditions": [
{
"rendition": "favicon-32",
"url": "https://example.com",
"width": 1,
"height": 1
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site