create_output_sheet_view

Create a read-only, immutable native sheet from one tabular output of a successful model run, and commit it. Rejects runs that are missing, still running, or failed; rejects access from a caller without at least Editor role on the model or from the wrong tenant; rejects non-tabular (not list-of-dict) outputs; rejects outputs whose row/column/cell counts exceed the sheet size limits.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model that owns the run.')]	Yes	—
run_id	Annotated[str, Field(description='UUID (or unique prefix) of the completed model run to create the sheet view from.')]	Yes	—
output_name	Annotated[str, Field(description='Name of the run output to render as a sheet -- must resolve to a tabular (list-of-dict) value. Use get_run to inspect available output names.', min_length=1)]	Yes	—
name	`Annotated[str	None, Field(description=“Display name for the sheet view. Defaults to ‘<output_name> (run )’ when omitted.”, max_length=MAX_SHEET_NAME_LENGTH)]`	No	None
tab_name	Annotated[str, Field(description="Name of the sheet's single tab.", min_length=1, max_length=MAX_TAB_NAME_LENGTH)]	No	Output
branch	`Annotated[str	None, Field(description=“Branch to commit the sheet view to. Defaults to the run’s branch.”)]`	No	None
commit_message	Annotated[str, Field(description='Git commit message. If omitted, the server generates a default message.')]	No	''

Returns

Returns a structured object. Top-level fields:

• model_name (string)
• sheet_id (string)
• name (string)
• purpose (string)
• run_id (string)
• run_branch (string)
• run_commit_sha (string)
• output_name (string)
• branch (string)
• commit_sha (string)
• sha (string)
• tab_id (string)
• tab_count (integer)
• row_count (integer)
• column_count (integer)
• data_hash (string)
• generated_at (string)
• calculation_status (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "create_output_sheet_view",
  "arguments": {
    "model_name": "forecasts",
    "run_id": "66666666-6666-6666-6666-666666666666",
    "output_name": "revenue_by_quarter"
  }
}

Response

{
  "model_name": "forecasts",
  "sheet_id": "sht_7890a1b2c3d4e5f67890a1b2c3d4e5f6",
  "name": "revenue_by_quarter (run 66666666)",
  "purpose": "output",
  "run_id": "66666666-6666-6666-6666-666666666666",
  "run_branch": "main",
  "run_commit_sha": "abc1234def5678901234567890abcdef12345678",
  "output_name": "revenue_by_quarter",
  "branch": "main",
  "commit_sha": "abc1234def5678901234567890abcdef12345678",
  "sha": "abc1234def5678901234567890abcdef12345678",
  "tab_id": "tab_890a1b2c3d4e5f67890a1b2c3d4e5f67",
  "tab_count": 1,
  "row_count": 5,
  "column_count": 3,
  "data_hash": "9f2b1c4d5e6f7890a1b2c3d4e5f678901a2b3c4d5e6f7890a1b2c3d4e5f6789",
  "generated_at": "2026-04-28T10:00:00+00:00",
  "calculation_status": "clean"
}

Notes

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