Save brand style guide
Creates or replaces the brand's style guide. guide is validated, and its asset ids must be the brand's own LOGO and FONT assets. confirmed: true stamps confirmedAt; false leaves the guide as a draft.
bearerAuthAuthorizationBearer <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.
brandId*integerThe brand the request acts on. Every brand-scoped resource lives under its brand.
application/json- body
sourceUrl*|The website the guide was built from, or null.
guide*confirmed*booleanTrue only when the user has approved the guide.
replacesSite?booleanTrue only when the user chose sourceUrl as this brand's own website. Without it, a guide from another site than the brand's saved guide is refused, so a site read to make ads for another brand never replaces this brand's style.
Save brand style guide
application/json- response
guide*|nullconfirmedAt*|When the user approved the guide; null while it is a draft.
sourceUrl*string|nulllogo*|nullfontCss*stringCSS 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.
items <= 6[key: string]?unknowncurl -X PUT "https://example.com/v1/brands/0/style-guide" \ -H "Authorization: Bearer koast_sk_..." \ -H "Content-Type: application/json" \ -d '{ "sourceUrl": "string", "guide": { "palette": [ { "hex": "string", "role": "primary", "source": "measured" } ], "typography": { "heading": { "family": "string", "fallback": "serif", "source": "measured" }, "body": { "family": "string", "fallback": "serif", "source": "measured" } }, "shapes": { "corners": "string", "buttons": "string" }, "imagery": "string", "voice": "string", "dos": [ "string" ], "donts": [ "string" ] }, "confirmed": true }'{ "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 } ], "property1": null, "property2": null}Required scope: write. CLI: koast save-brand-style-guide, see Style Guide commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.
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.
Extract brand style
Renders url in a browser, reads its computed fonts, colours and shapes, and stores its logos, self-hosted font files, two screenshots and up to six of its own images (the hero, the og:image or twitter:image, and the largest content images) as brand assets. Synchronous; allow up to four minutes.