Skip to content

Revise Global Document

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

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.

Authorizations

Parameters

Path Parameters

doc_id
required

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

string

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

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The instruction for the AI rewrite of one global-context document.

object
instruction
required
string
>= 3 characters <= 4000 characters

Responses

202

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string