# Mog API

> Mog is a programmable spreadsheet platform with a full TypeScript/Rust SDK.
> The API provides programmatic access to workbooks, worksheets, cells, formulas,
> charts, tables, formatting, and 582 Excel-compatible functions.

## API Documentation

- [API Reference](https://sheetmog.ai/docs/api): Full interactive API documentation
- [API Spec (JSON)](https://sheetmog.ai/api-spec.json): Machine-readable API specification
- [Full API Reference (text)](https://sheetmog.ai/llms-full.txt): Complete API reference for LLMs

## API Structure

The API is organized around two root objects:

### Workbook (wb)

65 direct methods plus sub-APIs:

- **wb.sheets** (WorkbookSheets): 10 methods
- **wb.slicers** (WorkbookSlicers): 8 methods
- **wb.slicerStyles** (WorkbookSlicerStyles): 9 methods
- **wb.timelineStyles** (WorkbookTimelineStyles): 9 methods
- **wb.pivotTableStyles** (WorkbookPivotTableStyles): 5 methods
- **wb.functions** (WorkbookFunctions): 8 methods
- **wb.names** (WorkbookNames): 16 methods
- **wb.scenarios** (WorkbookScenarios): 8 methods
- **wb.history** (WorkbookHistory): 9 methods
- **wb.tableStyles** (WorkbookTableStyles): 7 methods
- **wb.cellStyles** (WorkbookCellStyles): 7 methods
- **wb.properties** (WorkbookProperties): 6 methods
- **wb.protection** (WorkbookProtection): 4 methods
- **wb.security** (WorkbookSecurity): 8 methods
- **wb.notifications** (WorkbookNotifications): 9 methods
- **wb.theme** (WorkbookTheme): 4 methods
- **wb.viewport** (WorkbookViewport): 5 methods
- **wb.changes** (WorkbookChanges): 1 methods
- **wb.links** (WorkbookLinks): 11 methods

### Worksheet (ws)

80 direct methods plus sub-APIs:

- **ws.cells** (WorksheetCellsAccessor): 1 methods
- **ws.whatIf** (WorksheetWhatIf): 3 methods
- **ws.smartArt** (WorksheetSmartArt): 21 methods
- **ws.changes** (WorksheetChanges): 1 methods
- **ws.formats** (WorksheetFormats): 24 methods
- **ws.layout** (WorksheetLayout): 30 methods
- **ws.view** (WorksheetView): 16 methods
- **ws.structure** (WorksheetStructure): 14 methods
- **ws.charts** (WorksheetCharts): 56 methods
- **ws.objects** (WorksheetObjectCollection): 16 methods
- **ws.shapes** (WorksheetShapeCollection): 4 methods
- **ws.pictures** (WorksheetPictureCollection): 3 methods
- **ws.textBoxes** (WorksheetTextBoxCollection): 3 methods
- **ws.drawings** (WorksheetDrawingCollection): 3 methods
- **ws.equations** (WorksheetEquationCollection): 5 methods
- **ws.wordArt** (WorksheetWordArtCollection): 5 methods
- **ws.connectors** (WorksheetConnectorCollection): 2 methods
- **ws.filters** (WorksheetFilters): 26 methods
- **ws.formControls** (WorksheetFormControls): 10 methods
- **ws.conditionalFormats** (WorksheetConditionalFormatting): 15 methods
- **ws.validations** (WorksheetValidation): 13 methods
- **ws.tables** (WorksheetTables): 50 methods
- **ws.pivots** (WorksheetPivots): 66 methods
- **ws.slicers** (WorksheetSlicers): 17 methods
- **ws.sparklines** (WorksheetSparklines): 20 methods
- **ws.comments** (WorksheetComments): 30 methods
- **ws.customProperties** (WorksheetCustomProperties): 5 methods
- **ws.hyperlinks** (WorksheetHyperlinks): 6 methods
- **ws.outline** (WorksheetOutline): 14 methods
- **ws.protection** (WorksheetProtection): 16 methods
- **ws.print** (WorksheetPrint): 19 methods
- **ws.settings** (WorksheetSettings): 5 methods
- **ws.bindings** (WorksheetBindings): 10 methods
- **ws.names** (WorksheetNames): 9 methods
- **ws.styles** (WorksheetStyles): 3 methods