Get brand style guide

Returns the brand's style guide, when it was confirmed, the website it was built from, its logo asset, CSS that loads its fonts, the website images stored by the brand's latest extraction, the images the brand's users liked, disliked or picked as references, and whether the brand runs ads on an agency ad account from Koast, whose ads are reviewed against stricter rules than Meta's.

GET

/v1/brands/{brandId}/style-guide

Authorization

bearerAuth

headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

Path Parameters

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

Response Body

Get brand style guide

application/json

response

guide*|null

confirmedAt*|

When the user approved the guide; null while it is a draft.

sourceUrl*string|null

logo*|null

fontCss*string

CSS that loads the guide's fonts. Paste it into the of an HTML layout before using the font families.

images*array<>

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 src in render-creative html.

Itemsitems <= 6

taste*

What the brand's people liked, disliked and picked as references, for this brand only.

modelImages*array<>

Images shown to you after this call

Itemsitems <= 12

agencyAdAccount*boolean

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.

[key: string]?unknown

curl -X GET "https://example.com/v1/brands/0/style-guide" \  -H "Authorization: Bearer koast_sk_..."

{  "guide": {    "palette": [      {        "hex": "string",        "role": "primary",        "name": "string",        "source": "measured"      }    ],    "typography": {      "heading": {        "family": "string",        "weight": 100,        "fallback": "serif",        "source": "measured",        "assetIds": [          1        ]      },      "body": {        "family": "string",        "weight": 100,        "fallback": "serif",        "source": "measured",        "assetIds": [          1        ]      }    },    "shapes": {      "corners": "string",      "buttons": "string",      "cards": "string",      "lines": "string",      "other": "string"    },    "logo": {      "assetId": 1,      "use": "onDark"    },    "imagery": "string",    "voice": "string",    "dos": [      "string"    ],    "donts": [      "string"    ]  },  "confirmedAt": "string",  "sourceUrl": "string",  "logo": {    "assetId": -9007199254740991,    "url": "string",    "property1": null,    "property2": null  },  "fontCss": "string",  "images": [    {      "assetId": -9007199254740991,      "url": "string",      "label": "string",      "property1": null,      "property2": null    }  ],  "taste": {    "liked": [      {        "imageUrl": "string",        "creativeId": -9007199254740991,        "at": "string",        "property1": null,        "property2": null      }    ],    "disliked": [      {        "imageUrl": "string",        "creativeId": -9007199254740991,        "at": "string",        "property1": null,        "property2": null      }    ],    "references": [      {        "imageUrl": "string",        "source": "string",        "at": "string",        "property1": null,        "property2": null      }    ],    "property1": null,    "property2": null  },  "modelImages": [    {      "url": "string",      "label": "string",      "property1": null,      "property2": null    }  ],  "agencyAdAccount": true,  "property1": null,  "property2": null}

Required scope: read. CLI: koast get-brand-style-guide, see Style Guide commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.