Documentation Index
Fetch the complete documentation index at: https://gridos.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
GET /peek returns the contents of a rectangular cell range in one of three serialization formats. Use it when an agent has already scouted the workbook structure with /schema and needs the actual values from a specific block — for example, the first ten rows of a data table to decide what to compute over.
Request
An A1-notation range of the form
A1:D10. The two corners can be in either order — D10:A1 is normalized to the same rectangle. Both letters and digits are required on each side; bare column or row references (e.g. A:A, 1:10) are not accepted.Name of the sheet to read from. Defaults to the currently active sheet when omitted.
Serialization format. One of:
"csv"— comma-separated, with RFC 4180-style quoting for fields containing commas, quotes, or newlines. ReturnsContent-Type: text/csv."tsv"— tab-separated, no quoting. ReturnsContent-Type: text/tab-separated-values."json"— JSON object withsheet,range, androws(a 2-D array of values). ReturnsContent-Type: application/json.
Response
The response shape depends onformat. CSV and TSV return the serialized text directly with the appropriate Content-Type. JSON returns a structured object:
The sheet that was read.
The normalized A1 range that was returned (corners ordered top-left to bottom-right).
A 2-D array (array of arrays) of cell values in row-major order. Empty cells are returned as the empty string
"". Numeric cells are returned as JSON numbers; string cells as JSON strings; boolean cells as JSON booleans.HTTP errors
| Status | Meaning |
|---|---|
400 | range is not in A1:D10 form, contains an invalid A1 notation, or format is not one of csv, tsv, json. |
404 | The supplied sheet does not exist in the workbook. |
413 | The range covers more than 1000 cells. Narrow the range or split into multiple peeks. |
Examples
CSV (default)
C2 is empty).
TSV
JSON
CSV escaping
Fields containing a comma, double-quote, or newline are wrapped in double quotes, with internal double quotes doubled, following RFC 4180:| Cell value | CSV output |
|---|---|
Smith, John | "Smith, John" |
She said "hi" | "She said ""hi""" |
line 1\nline 2 | "line 1\nline 2" (the newline is preserved inside the quotes) |
/peek returns each cell’s evaluated value, not its formula text. A cell containing =SUM(A1:A10) returns the computed sum; the formula itself is not exposed through /peek. Use POST /eval when you need to inspect formulas, or GET /api/workbook for a full state dump that includes formula strings.