get_brand_kit
The organization’s brand kit, resolved: what a branded document should look like.
Each field is answered by the first tier that has it — the kit saved on the organization’s settings page, then the organization’s brand assets (its Creative Studio brand logos, and logo files in the workspace’s /org/brand/ folder not yet moved there, classified from placement, filename and pixels), then the organization record (its name, its logo), then a neutral default. sources says which tier answered every field, so "floor" means “nobody set this” rather than “the customer chose the default”. A missing logo is never replaced with the Adlyse mark.
Parameters#
None.
Returns#
json
{
"brand_kit": {
"brand_name": "Northwind Media",
"logos": {
"primary": {
"role": "primary",
"source": "explicit",
"path": "/org/brand/logos/northwind--ad_crtv_01HZ....png",
"file_asset_id": "file_asset_01HZ...",
"creative_id": "ad_crtv_01HZ...",
"url": "https://app.adlyse.com/api/files/file_asset_01HZ.../content",
"mimetype": "image/png",
"width_px": 1200,
"height_px": 400,
"has_transparency": true,
"background_fit": "any"
},
"on_dark": { "role": "on_dark", "source": "inferred", "path": "/org/brand/logos/northwind-white--ad_crtv_01HY....png", "...": "..." }
},
"palette": { "accent": "#1a73e8", "secondary": "#295a7e", "ink": "#20231f", "surface": "#ffffff" },
"tokens": {
"--brand-accent": "#1a73e8",
"--brand-accent-soft": "#e3ecfc",
"--brand-on-accent": "#ffffff",
"--brand-accent-chart": "#1a73e8",
"--brand-ink": "#20231f",
"--brand-font-heading": "\"Inter\", sans-serif",
"--brand-font-body": "\"Noto Serif\", serif",
"--brand-font-mono": "\"JetBrains Mono\", monospace"
},
"typography": {
"heading": { "key": "inter", "css_family": "Inter", "generic": "sans-serif" },
"body": { "key": "noto-serif", "css_family": "Noto Serif", "generic": "serif" },
"mono": { "key": "jetbrains-mono", "css_family": "JetBrains Mono", "generic": "monospace" }
},
"footer_text": "Questions about this report? Ask your account manager.",
"show_adlyse": true,
"sources": { "brand_name": "organization", "logo_primary": "explicit", "accent": "explicit", "ink": "floor", "font_heading": "floor" },
"warnings": []
},
"source": "brand_kit"
}| Field | Description |
|---|---|
logos | Keyed by role: primary (light backgrounds), on_dark, icon. Only roles that resolved are present. url is an authenticated app link, never a storage URL. |
palette | Four hex colours. tokens carries the derived shades and contrast-checked pairs every renderer uses. |
typography | Catalog keys with their CSS family names. Fonts outside the catalog cannot be set. |
sources | One of explicit, inferred, organization, floor, or missing (an explicitly chosen logo that is no longer in the workspace; nothing is substituted). |
warnings | Human-readable notes: a missing chosen logo, an ink/surface pair too faint for body text. |
Errors#
error_type | When |
|---|---|
auth_error | Missing / invalid API key |
See also#
get_guideline— the Brand Profile (voice, positioning); this tool is the visual identitylist_files— browse/org/brand/directly (read-only where the Creative Studio is on)