Brand Kit

Re Extract Design System

Re-scrape the website and rebuild the Design system. SPENDS CREDITS (it can regenerate the style guide).

Rebuilds the brand snapshot, and the style guide when the URL changed. It does not touch the organisation's primary website, content sources or company profile. website_url is REQUIRED (unlike POST /brand-kit/extract). The app's own guards apply: 402 when the organisation cannot pay (check_credits runs inside the handler, before anything is queued), 400 for a URL that is not a public site, 409 while a re-extract or a document run is already going, 429 for a minute after one starts. Asynchronous: poll GET /brand-kit/re-extract/status.

post/brand-kit/re-extract

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/brand-kit/re-extract
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

website_urlstring required

Response

Successful Response

dataStudioPayload required

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.

Changes

No recorded changes to this operation across all 3 revisions of this API.