create_bsheet_output_view
Create a read-only native sheet from a selected tabular output of a successful model run when explicitly asked. Use get_run_output for raw output and get_bsheet to read an existing sheet. Accepts records or ordered {columns, rows} tables within Native Sheet limits; optional presentation hints affect formatting only. By default the view is pinned to run_id.
Parameters
Section titled “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 | — | |
follow_input_edits | Annotated[bool, Field(description='Opt this view into live following of successful automatic input-edit runs from the same attached entrypoint and branch. The selected run must have an input-edit receipt. Defaults to false, which keeps this as a pinned historical snapshot.')] | No | False | |
follow_successful_runs | Annotated[bool, Field(description='Opt this view into successful ordinary run_model runs from the same model, branch, entrypoint, and parameter context. Comparison, scheduled, and local-upload runs, input-edit receipt runs, and runs with an experiment source marker are excluded. Defaults to false.')] | No | False | |
output_name | Annotated[str, Field(description="Name of the run output to render as a sheet -- must resolve to a list-of-dict table or a {columns: [...], rows: [[...]]} table. Resolves with or without a trailing '.json' when unambiguous. 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 | 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' | |
currency | `Annotated[str | None, Field(description=‘Optional active ISO 4217 override; otherwise inherit the model.’)]` | No | None |
locale | `Annotated[str | None, Field(description=‘Optional supported display-locale override; otherwise inherit the model.’)]` | No | None |
column_hints | `Annotated[list[ColumnFormatHint] | None, Field(description=“Per-column presentation hints, at most one per column: type is text/number/currency/percent/date/multiple (mirrors create_dashboard_from_run’s data_grid vocabulary plus percent/multiple), decimals is optional. Columns with no hint still get a safe numeric default. Presentation only — values are never changed.”)]` | No | None |
emphasize_rows | `Annotated[list[int] | None, Field(description=‘0-based data-row indices (header row excluded) to bold-emphasize, e.g. subtotal/total rows.’)]` | No | None |
frozen_label_column | Annotated[bool, Field(description='Freeze the first column, in addition to the header row.')] | No | False | |
row_formats | `Annotated[list[RowFormatHint] | None, Field(description=“Per-row presentation hints, keyed by the exact value of the row’s first column (its label) rather than a positional index — applies to every row whose first column matches. type/decimals mirror column_hints; bold styles the row, e.g. a subtotal/total row. Wins over column_hints for a matched row. Presentation only — values are never changed.”)]` | No | None |
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 | '' | |
workspace_id | `Annotated[str | None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]` | No | None |
Returns
Section titled “Returns”Returns a structured object. Top-level fields:
schema_version(string)operation(string)outcome(string)artifact_type(string)occurred_at(string)warnings(array)warning_count(integer)warnings_truncated(boolean)open_link(object)open_url(string)open_url_state(string)open_url_reason(null)follow_up(array<object>)model_name(string)workspace_id(string)sheet_id(string)sheet_view_id(string)name(string)purpose(string)run_id(string)run_short(string)run_branch(string)run_commit_sha(string)follow_input_edits(boolean)follow_successful_runs(boolean)output_name(string)branch(null)commit_sha(string)sha(string)tab_id(string)tab_name(string)tab_count(integer)row_count(integer)column_count(integer)data_hash(string)hash(string)presentation_hash(null)profile_version(null)generated_at(string)calculation_status(string)
See the response example below for the full payload shape.
Example
Section titled “Example”Tool Call
Section titled “Tool Call”{ "name": "create_bsheet_output_view", "arguments": { "model_name": "forecasts", "run_id": "66666666-6666-6666-6666-666666666666", "output_name": "revenue_by_quarter" }}Response
Section titled “Response”{ "schema_version": "artifact-mutation-receipt.v1", "operation": "create", "outcome": "created", "artifact_type": "native_sheet_output", "occurred_at": "2026-04-28T10:00:00+00:00", "warnings": [], "warning_count": 0, "warnings_truncated": false, "open_link": { "url": "https://app.bridge-town.example/models/handoff?ws=dddddddd-dddd-dddd-dddd-dddddddddddd&model=forecasts&sheet_view_id=12121212-1212-1212-1212-121212121212", "unavailable_reason": null }, "open_url": "https://app.bridge-town.example/models/handoff?ws=dddddddd-dddd-dddd-dddd-dddddddddddd&model=forecasts&sheet_view_id=12121212-1212-1212-1212-121212121212", "open_url_state": "available", "open_url_reason": null, "follow_up": [ { "tool": "get_bsheet", "arguments": { "model_name": "forecasts", "sheet_id": "sht_7890a1b2c3d4e5f67890a1b2c3d4e5f6", "tab_id": "tab_890a1b2c3d4e5f67890a1b2c3d4e5f67", "workspace_id": "dddddddd-dddd-dddd-dddd-dddddddddddd", "row_start": 0, "row_limit": 50, "column_start": 0, "column_limit": 20 } } ], "model_name": "forecasts", "workspace_id": "dddddddd-dddd-dddd-dddd-dddddddddddd", "sheet_id": "sht_7890a1b2c3d4e5f67890a1b2c3d4e5f6", "sheet_view_id": "12121212-1212-1212-1212-121212121212", "name": "revenue_by_quarter (run 66666666)", "purpose": "output", "run_id": "66666666-6666-6666-6666-666666666666", "run_short": "66666666", "run_branch": "main", "run_commit_sha": "abc1234def5678901234567890abcdef12345678", "follow_input_edits": false, "follow_successful_runs": false, "output_name": "revenue_by_quarter", "branch": null, "commit_sha": "abc1234def5678901234567890abcdef12345678", "sha": "abc1234def5678901234567890abcdef12345678", "tab_id": "tab_890a1b2c3d4e5f67890a1b2c3d4e5f67", "tab_name": "Output", "tab_count": 1, "row_count": 5, "column_count": 3, "data_hash": "9f2b1c4d5e6f7890a1b2c3d4e5f678901a2b3c4d5e6f7890a1b2c3d4e5f6789", "hash": "9f2b1c4d5e6f7890a1b2c3d4e5f678901a2b3c4d5e6f7890a1b2c3d4e5f6789", "presentation_hash": null, "profile_version": null, "generated_at": "2026-04-28T10:00:00+00:00", "calculation_status": "clean"}- Module:
BSheets - Requires an authenticated Bridge Town session (OAuth) or an API token.