Trigger Brand Extraction
POST /brand-kit/extract
Start, or restart, brand extraction.
Omit the body to re-extract the website already on the org’s company
profile. Supplying website_url EXTRACTS A DIFFERENT SITE and replaces
the org’s design tokens and homepage capture with that site’s - which is
how a brand kit ends up belonging to the wrong company. Asynchronous; the
result appears on GET /brand-kit.
Authorizations
Parameters
Header Parameters
Request Body
Mirrors campaign_builder.routers.brand_kit.TriggerExtractionPayload.
website_url omitted re-runs extraction against the website already on the
org’s company profile. Supplying one EXTRACTS A DIFFERENT SITE, which
replaces the org’s design tokens and homepage capture.
Responses
202
Successful Response
object
An open envelope for one settings block, document or brand artefact.
OPEN on purpose. These surfaces are configuration and generated content, and both grow: a new toggle on a settings block or a new field on a generated document must reach a caller on the day it ships, not on the day somebody remembers to widen a mirror. A closed response model here would silently DROP the new key, which reads to the caller as “the product does not have that setting”.
The request side is the opposite and is mirrored exactly - see the module docstring for why the asymmetry is deliberate.
object
422
Validation Error