API Reference

Structured Sheets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Tables

Convert uploaded spreadsheets into structured data. Creates relational tables from messy spreadsheet data.

List tables in structured sheet

client.structuredSheets.tables.list(stringstructuredSheetID, TableListParams { after, limit } query?, RequestOptionsoptions?): CursorIDPage<TableResponse { id, created_at, name, 4 more } >

GET/v1/structured-sheets/{structured_sheet_id}/tables

Retrieve a table

client.structuredSheets.tables.retrieve(stringtableID, TableRetrieveParams { structured_sheet_id } params, RequestOptionsoptions?): TableResponse { id, created_at, name, 4 more }

GET/v1/structured-sheets/{structured_sheet_id}/tables/{table_id}

Download table data

client.structuredSheets.tables.download(stringtableID, TableDownloadParams { structured_sheet_id, format } params, RequestOptionsoptions?): Response

GET/v1/structured-sheets/{structured_sheet_id}/tables/{table_id}/download

ModelsExpand Collapse

TableResponse { id, created_at, name, 4 more }

Response representing a table extracted from a structured sheet.

This is returned from GET (retrieve) and list table endpoints. Table names use a composite format: {normalized_sheet_name}__{table_name}.

id: string

The unique identifier for this table.

created_at: string

The timestamp when this table was created.

formatdate-time

name: string

Composite table name: {normalized_sheet_name}__{table_name}. Uses lowercase snake_case. Aggregation tables end with '__aggregations'. Two special metadata tables exist per structured sheet: '__deeptable_workbook_metadata' (workbook provenance info) and '__deeptable_table_overview' (summary of all tables). Example: 'staffing__head_count' or 'staffing__head_count__aggregations'.

maxLength255

object: "table"

The object type, which is always 'table'.

sheet_name: string

The original Excel sheet name this table came from.

maxLength100

structured_sheet_id: string

The ID of the structured sheet this table belongs to.

type: "relational" | "aggregation" | "tableless" | "metadata"

The type of table (relational, aggregation, tableless, or metadata).

One of the following:

"relational"

"aggregation"

"tableless"

"metadata"