GTM Context

Revise Global Document

Queue an AI rewrite of one global-context document. THIS SPENDS CREDITS (a model job).

The result lands as a draft; the live text is untouched until you draft/accept. A follow-up instruction builds on a pending draft. 402 when the organisation cannot pay, 400 when the document has no content yet.

post/global-context/documents/{doc_id}/revise

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/global-context/documents/{doc_id}/revise
  • Auth: HTTP bearer

Path parameters

doc_idstring required

The document id (UUID) or its type, e.g. brand_brief.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

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