Skip to main content
POST
Call brand_kit.set_adherence

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
level
enum<string>
required

tight = stick to the brand exactly; balanced = mostly; loose = use it as a reference only (the facts still hold).

Available options:
tight,
balanced,
loose
target
enum<string>
required

turn = what the member just said about THIS piece in chat; piece = the piece's own setting; kit = the brand's default for everything.

Available options:
turn,
piece,
kit
piece_title
string

For turn and piece, when no piece is open in this conversation: the piece's title, in the member's words.

Required string length: 1 - 200
confirmation_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
state
required
Allowed value: "confirmation_required"
level
enum<string>
required
Available options:
tight,
balanced,
loose
target
enum<string>
required
Available options:
turn,
piece,
kit
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.

confirmation_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
expires_in_seconds
integer
request_summary
string

What will happen, in one sentence, for a person to approve before confirming.

piece_title
string
current_level
enum<string>
Available options:
tight,
balanced,
loose
line
string