getBrandKit
Retrieve a site's brand colors and fonts to ensure design consistency for widgets, pages, and emails. Call once at the start of any design task.
Instructions
Get the site's brand kit (colors + fonts) for design decisions - Return a compact, semantically-labeled brand kit for this BD site - colors (body / primary / dark / muted / success / warm / alert accents, card surface) + fonts (body + heading Google Fonts). Call this ONCE at the start of any design-related task (building a widget, WebPage, post template, email, hero banner - anything where colors or fonts are chosen) so the output visually matches the site's brand.
Handler is synthetic - makes 20 parallel internal calls to /api/v2/website_design_settings/get?property=setting_name&property_value=custom_N&property_operator== (one per brand-kit slot), then transforms the raw custom_N values into semantic labels. Uses BD's canonical mapping (same mapping BD's admin AI Companion applies). Parallel calls complete in ~1s wall-clock on typical sites; well under the 100 req/60s rate limit even on repeated invocations.
No args. Read-only. Safe to call anytime.
Response shape:
{
body: { background, text, font },
primary: { color, text_on },
dark: { color, text_on },
muted: { color, text_on },
success_accent: { color, text_on },
warm_accent: { color, text_on },
alert_accent: { color, text_on },
card: { background, border, text, title },
heading_font: "<google font family>",
usage_guidance: { primary, dark, muted, success_accent, warm_accent, alert_accent, tint_rule, font_rule }
}Usage guidance embedded in response - agents should read it every call. Key rules:
Primary = brand color - main CTAs, dominant accents.
Dark = high-contrast sections or strong backgrounds.
Muted = subtle section backgrounds, dividers, badges, pills.
Success / Warm / Alert accents = specific semantic states (confirmations / attention / urgency). Use sparingly.
Tint rule: derive lighter/darker tints from palette colors for hover states, gradients, low-emphasis backgrounds. Do NOT introduce new unrelated hues.
Font rule: the site's
body.fontandheading_fontGoogle Fonts are already globally loaded by BD. Do NOT redefine them incontent_css. To switch to a different font, load it via a<link rel="stylesheet" href="https://fonts.googleapis.com/...">tag incontent_head— never@importinside CSS (Outlook + some BD widget contexts strip or fail on@import).
When a slot is empty on the site, the handler applies BD's documented fallback defaults (same defaults BD's admin AI Companion uses). Response is never missing keys - every field always has a value.
Auth: X-Api-Key header. Rate limit: 100 req/60s. Caches well on the agent side - the brand kit rarely changes within a session; call once, reuse.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||