Skip to main content
POST
Call funnel.scaffold

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

The plan text the operator agreed to — the one funnel.plan produced, with whatever they changed in it. Never a plan you rewrote on your own.

Minimum string length: 1
project_name
string
required

What to call the project. Take it from the plan unless the operator named it themselves.

Minimum string length: 1
parts
enum<string>[]
required

The same parts the plan covers. One board is created per part, inside the project, in build order.

Required array length: 1 - 7 elements
Available options:
landing_pages,
email_sequences,
pipeline,
automations,
creative,
tracking,
data_table
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
project_board_id
string
required
project_name
string
required
plan_document_id
string
required
parts
object[]
required
answer_note
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.