Skip to main content
POST
Call brand_kit.read

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
group
enum<string>

One section of the kit, by the name the Brand page gives it. Leave it out to read the whole kit; a long section comes back in part, and omitted names what to read next.

Available options:
identity,
offer,
audience,
verbal,
visual,
reach,
video
kind
string

Leave it out on a first read: the whole kit, or one group, already lists every fact under its label. Pass it only to read the whole of a list a previous read shortened (shown below its count), copying that list's kind exactly from the read's sections — a catalogue name like one_liner or voice.tone, never the member's own word for the fact.

Minimum string length: 1
cursor
string

Leave it out except to continue a list: it is only ever the next_cursor the last read of the same kind returned, copied exactly. A first page takes no cursor, and a page number is not one.

Minimum string length: 1
library_query
string

Leave it out unless the member is looking for a picture: a word to find pictures by — a label, a kind or a tag ('book cover', 'person', 'product').

Maximum string length: 120
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
name
string
required
adherence
enum<string>
required
Available options:
tight,
balanced,
loose
sections
object[]
required
facts
object[]
required
library
object[]
required
fill
object
required
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.

logo
object | null
guidelines_locked
boolean
page
object
next_cursor
string
omitted
object