v15

latestOpenAPI 3.1.0raw.githubusercontent.com2025-11-11104961.0 KB

workbooks

Read and write cell values from a workbook

Run calculations in a workbook and retrieve cell objects.

post/v1/workbooks/{id}/calc

Path parameters

idstring required

Request body

applyobject nullable

Map of cell references to values. The values are written to cells in the spreadsheet before performing the read operation. You can write numbers, strings, and booleans. Values applied within a request are temporary and affect only that specific request. They are not permanently written to the original spreadsheet.

{
  "apply": { "A1": 10, "A2": 2.718, "A3": "Total", "A4": true, "A5": null },
  // ...
}

readstring[] required

Example request

{
  "apply": {
    "A1": 100,
    "A2": 2.718,
    "A3": "Total",
    "A4": true
  },
  "read": [
    "A1"
  ]
}

Response

Successful Response

CalcObjectResponse required

Response type returned by the for /calc query endpoint.

All 10 operations