Get brand style guide
Returns the active brand's style guide, when the user confirmed it, its logo, fontCss: CSS that loads the guide's fonts in an HTML layout, the website images kept by the last extract-brand-style, and taste: the images the brand's people liked, disliked or picked as references, and agencyAdAccount: whether the brand runs ads on an agency ad account from Koast, whose ads the partner also reviews, with stricter rules than Meta's.
Tool name: get-brand-style-guide.
Returns the active brand's style guide, when the user confirmed it, its logo, fontCss: CSS that loads the guide's fonts in an HTML layout, the website images kept by the last extract-brand-style, and taste: the images the brand's people liked, disliked or picked as references, and agencyAdAccount: whether the brand runs ads on an agency ad account from Koast, whose ads the partner also reviews, with stricter rules than Meta's. You are shown the images after the call. Read-only.
When to use
Before making ad images or layouts, to use the brand's colours, fonts and logo. When there is no guide, or it is not confirmed, build one first.
Access
| Property | Value |
|---|---|
| Required scope | read |
| Publishes | No |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
| Open world | No |
Input
This tool takes no input.
Output
| Field | Type | Required | Description |
|---|---|---|---|
guide | object | null | Yes | |
confirmedAt | string | null | Yes | When the user approved the guide; null while it is a draft. |
sourceUrl | string | null | Yes | |
logo | object | null | Yes | |
fontCss | string | Yes | CSS that loads the guide's fonts. Paste it into the <style> of an HTML layout before using the font families. |
images | object[] | Yes | The site's own images: product shots, app screens, the hero and its social image, stored as brand assets. Pass a url as an imageUrl reference to generate-creatives, or use it as an <img> src in render-creative html. At most 6 items. |
taste | object | Yes | What the brand's people liked, disliked and picked as references, for this brand only. |
modelImages | object[] | Yes | Images shown to you after this call. At most 12 items. |
agencyAdAccount | boolean | Yes | true when the brand runs ads on an agency ad account from Koast: the partner reviews every ad as well as Meta, and its rules are stricter. |
REST equivalent
GET /v1/brands/{brandId}/style-guide, Get brand style guide. CLI: koast get-brand-style-guide.
Extract brand style
Opens a website in a browser and measures its brand style: fonts, colours, button and card shapes, the logo, and page screenshots.
Get brand website candidates
Lists the websites that may belong to the active brand: the website saved on the brand, the domain of the user's email, and the domains its recent ads link to.