create_dashboard_from_run

Create a dashboard from one successful model-run output. Requires chart_type, model_run_id, and output_key. Use publish_repo_dashboard for a committed HTML package.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model.')]	Yes	—
dashboard_name	Annotated[str, Field(description='Unique name for this dashboard.')]	Yes	—
chart_type	Annotated[str, Field(description='Chart type supported by the dashboard resource.')]	Yes	—
model_run_id	Annotated[str, Field(description='UUID of a successful model run.')]	Yes	—
output_key	Annotated[str, Field(description='Named output from the model run to render.')]	Yes	—
description	`Annotated[str	None, Field(description=‘Optional description displayed below the dashboard title.’)]`	No	None
subtitle	Annotated[str, Field(description='Optional subtitle displayed below the title.')]	No	''
currency	Annotated[str, Field(description='ISO 4217 currency code for monetary values.')]	No	'USD'
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None
ctx	`Context	None`	No	None

Returns

Returns a structured object. Top-level fields:

• dashboard_id (string)
• dashboard_name (string)
• model (string)
• chart_type (string)
• model_run_id (string)
• created (boolean)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "create_dashboard_from_run",
  "arguments": {
    "model_name": "forecasts",
    "dashboard_name": "Q4 Revenue",
    "chart_type": "bar",
    "model_run_id": "66666666-6666-6666-6666-666666666666",
    "output_key": "quarterly_revenue.json",
    "currency": "USD"
  }
}

Response

{
  "dashboard_id": "77777777-7777-7777-7777-777777777777",
  "dashboard_name": "Q4 Revenue",
  "model": "forecasts",
  "chart_type": "bar",
  "model_run_id": "66666666-6666-6666-6666-666666666666",
  "created": true
}

Notes

• Module: Dashboards
• Requires authentication via API token or Auth0 JWT.