Skip to main content
POST
Call shorts.try_shape

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
tile_id
string
required

The competitor tile's id, exactly as the plan listed it.

Minimum string length: 1
already_tried
string[]

The tile ids already tried on this plan — pass back what the last call returned.

Maximum array length: 5
Minimum string length: 1
board_id
string<uuid>

An existing week's board id, when trying a shape on one.

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
shape
string
required
card
object
required
week_size
integer
required
already_tried
string[]
required

Pass this back as already_tried on the next try, and as extra_shapes when you make the week.

shelf
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.