Brand Kit

Plan Custom Template

Preview the section plan for an idea. Builds nothing, stores nothing.

The review step: it returns the plan a build WOULD follow, so the plan can be edited and handed back to POST /layout-templates/custom instead of discovering the interpretation was wrong after the page exists.

post/brand-kit/layout-templates/custom/plan

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/brand-kit/layout-templates/custom/plan
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

ideastring required

Plain-language description of the page to plan.

namestring nullable

Short title.

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 2 revisions of this API.