create_project
Create a new Bridge Town project. When scaffold=True (default), the project is pre-seeded with a working auto-discovery run.py scaffold and a starter financial model at model/my_model.py — use this to start modelling immediately. When scaffold=False, an empty project is created with a minimal run.py placeholder, ready for you to populate with your own models. The calling user is granted Owner access to the new project. Returns: project (str) — name of the created project; description (str) — project description; run_py (str|null) — scaffold run.py content when scaffold=True, null otherwise; model_py (str|null) — starter model content when scaffold=True, null otherwise.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
project_name | str | Yes | — | |
scaffold | bool | No | True | |
description | str | No | '' |
Returns
Section titled “Returns”Returns a structured object. Top-level fields:
project(string)description(string)run_py(string)model_py(string)
See the response example below for the full payload shape.
Example
Section titled “Example”Tool Call
Section titled “Tool Call”{ "name": "create_project", "arguments": { "project_name": "forecasts", "scaffold": true, "description": "FY26 revenue and cash forecasts" }}Response
Section titled “Response”{ "project": "forecasts", "description": "FY26 revenue and cash forecasts", "run_py": "# scaffolded run.py content...", "model_py": "# scaffolded model/my_model.py content..."}- Module:
Projects - Requires authentication via API token or Auth0 JWT.