SumSheet reference

If this is your first time here

The reference answers “what’s the operation called and what does it accept”, not “where do I start”. The full workflow is shown in the quick start: open a workbook, write a value and a formula, recalculate, and save.

How the session works and what a response contains are in How the session API works; a breakdown of every call from the example is in Sample requests; and if something isn’t working, see diagnostics.

The SumSheet reference describes working with XLSX spreadsheets. For DOCX documents, there’s the SumDoc reference.

The Compute Contract is the only typed boundary between the interface, automation, adapters to your application and the SumSheet core in Rust. All 208 operations pass through it, wherever the core runs: in the desktop app, in the browser via WebAssembly or as a service on a server.

The contract and the release are different numbers

208 operations are described in the contract. The core of the latest published release accepts 206 of them: two are in the contract but not yet in the build—drawing_object_history_replay, sparkline_history_replay. On their pages such operations are marked with a “not yet in the published release” callout. You can verify this on your own copy: ask the core for a nonexistent operation, and it will list all the ones it accepts.

Key conventions

The row and col indexes, as well as the bounds of the viewport, are numbered from zero: the first row is 0. Operations within a session pass the subsetId obtained from open_workbook_subset. The expectedRevision field, when present, protects against races: if the workbook has changed since the moment the caller last saw it, the request is rejected before the workbook changes, not halfway through.

Definitions of these and other terms are in the glossary.

Operation sections

Section	Operations	What it covers
Session and workbook	19	Opening a workbook subset, saving, the viewport, recovery, properties, comparing, and merging revisions.
Cells and ranges	23	Editing cells, reading details, shifts, copy and paste, find and replace, sorting, undo and redo, navigating the sheet.
Sheets	17	Sheet lifecycle, copying between workbooks, visibility, protection, and freezing panes.
Printing and layout	7	Page setup, breaks, sheet background, and printing chart sheets.
Formulas and calculation	17	Recalculation, calculation modes, dependency tracing, formula auditing, named ranges, and what-if analysis.
Formatting	10	Column width and row height, merging cells, themes and fonts, conditional formatting.
Data, filters, and objects	23	Filters, subtotals, data cleanup, tables, text import, data validation, slicers, and form controls.
Pivot tables	11	Cache, calculated fields and items, grouping and drill-down, layout, report filters, sorting, and value field settings.
Power Query: M expressions	9	Evaluating and inspecting M expressions, including with external sources.
Power Query: connectors	13	Connecting to Postgres, SQL Server, OData, and web sources: testing the connection, previewing, and navigating objects.
Power Query: queries and steps	13	Query lifecycle, applied steps, parameters, and folder navigation.
Power Query: tables from queries	8	Loading a query’s result onto a sheet, refreshing such tables, and the link between a table on a sheet and the query that fills it.
Power Query: execution and progress	9	The query graph, refreshing, cancellation, and monitoring long-running operations.
Power Query: trust and privacy	6	Source privacy levels, trust decisions, and connection settings.
Power Query: external mashups	3	Reading, writing, and refreshing Power Query query sets assembled outside the product.
VBA and macros	12	Project inspection, planning and running, status, cancellation and rollback, macro trust, and the approved list.
Protection and review	8	Sheet and workbook protection, range permissions, protection auditing, change tracking, comments, and ink annotations.

Type dictionary

The “TypeScript type” column holds names like ViewportWindow or ContractSubsetSessionInfo. Their definitions are collected in the type dictionary—959 names, arranged by the same topics as the operations. Every name in the field tables leads straight to its definition.

Returning under a different name

An operation can return a success payload with a different operation: open_workbook_subset_from_bytes → open_workbook_subset; move_clipboard_range → paste_range; paste_conditional_formatting_rules → apply_conditional_formatting_rules.