WorkbookAPI

Use before trusting a workbook's calculations to compare recalculated formulas with Excel's saved values. Returns compared/matching totals, up to 200 mismatches with formula, saved/recalculated values and cause, feature flags, skipped counts, the workbook's dateSystem ("1900" or "1904"), and load/recalculation milliseconds. Dates are serial numbers in the workbook's date system. Above the 20000-byte response budget, mismatch details are shortened with an explicit message and totals retained. Only eligible cached formulas are compared; a matching check does not cover skipped cells or unsupported features.

Use to discover sheets, used ranges, defined names and the workbook's dateSystem ("1900" or "1904") before choosing inputs and outputs. Dates are serial numbers in the workbook's date system. Names include values up to 100 cells, or range address and dimensions for larger blocks (expression arrays have a null address). Pass sheet for referenced constant or blank inputs and terminal formula outputs. Lists are capped at 100 entries. Above the 20000-byte response budget including both copies, named values are omitted with valuesOmitted: true; discovery lists may be shortened with an explicit message. Static discovery can miss dynamic or structured references.

Use to calculate one scenario from a local workbook with changed constant inputs and selected cells, ranges or defined names as outputs. Returns full-precision numbers, strings, booleans, null for direct blanks and {error: code} for spreadsheet errors; named references to blanks return 0, dates are serial numbers in the workbook's date system and ranges are arrays of rows. Each call starts from the original workbook and includes compatibility warnings; formula cells cannot be inputs. Responses are capped at 20000 bytes including both copies; oversized results return an explicit error.

Use to compare many input sets for the same workbook and outputs in one call. Returns indexed rows with values or errors, warnings and elapsed milliseconds. Dates are serial numbers in the workbook's date system. Each scenario starts from the original workbook and all its outputs share one recalculation. Runs stop at 10,000 scenarios, 100,000 output values, 20000 bytes including both response copies, cancellation or the time budget (55 seconds, with a 60-second hard deadline), reporting completed count and truncation. An engine crash during a scenario adds an error row counted in completed and stops the run; a crash before scenarios start returns an error. Resume by sending scenarios.slice(completed); check truncationReason before retrying and reduce outputs for output limits.