Skip to main content
POST
Call shorts.compose_plan

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
brief_id
string

The short's brief id. If this conversation has named one, pass it — a named id always wins. If none has been named and the person is on a short's plan and means that plan ('show me the plan', 'make it'), LEAVE IT OUT: the tool acts on the plan on screen. If none has been named and no plan is open, do not call this — ask which short they mean. Never invent an id.

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
ready
boolean
required

False when a question is still open — then nothing is drawn.

title
string | null
required
readback
string | null
required
learned
string | null
required
style
string | null
required
length
string | null
required
ratio
string | null
required
beats
object[]
required
standing
object[]
required
open_questions
string[]
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.

brief_id
string

The brief this acted on — the plan on screen when no usable id was given.

their_words
object | null