Skip to content
DeepTable
Get started
API Reference

Structured Sheets

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

List structured sheets
client.structuredSheets.list(StructuredSheetListParams { after, limit } query?, RequestOptionsoptions?): CursorIDPage<StructuredSheetResponse { id, created_at, file_id, 6 more } >
GET/v1/structured-sheets
Create structured sheet
client.structuredSheets.create(StructuredSheetCreateParams { file_id, sheet_names } body, RequestOptionsoptions?): StructuredSheetResponse { id, created_at, file_id, 6 more }
POST/v1/structured-sheets
Delete structured sheet
client.structuredSheets.delete(stringstructuredSheetID, RequestOptionsoptions?): StructuredSheetDeleteResponse { id, deleted, object }
DELETE/v1/structured-sheets/{structured_sheet_id}
Retrieve structured sheet
client.structuredSheets.retrieve(stringstructuredSheetID, RequestOptionsoptions?): StructuredSheetResponse { id, created_at, file_id, 6 more }
GET/v1/structured-sheets/{structured_sheet_id}
Cancel structured sheet processing
client.structuredSheets.cancel(stringstructuredSheetID, RequestOptionsoptions?): StructuredSheetResponse { id, created_at, file_id, 6 more }
POST/v1/structured-sheets/{structured_sheet_id}/cancel
Download structured sheet export
client.structuredSheets.download(stringstructuredSheetID, StructuredSheetDownloadParams { format } query?, RequestOptionsoptions?): Response
GET/v1/structured-sheets/{structured_sheet_id}/download
ModelsExpand Collapse
StructuredSheetResponse { id, created_at, file_id, 6 more }

Response representing a structured sheet conversion job.

This is returned from POST (create), GET (retrieve), and list endpoints.

id: string

The unique identifier for this structured sheet conversion.

created_at: string

The timestamp when the conversion was started.

formatdate-time
file_id: string

The unique identifier for the source file.

object: "structured_sheet"

The object type, which is always 'structured_sheet'.

status: "queued" | "in_progress" | "completed" | 2 more

The current processing status.

One of the following:
"queued"
"in_progress"
"completed"
"failed"
"cancelled"
updated_at: string

The timestamp when the conversion was last updated.

formatdate-time
last_error?: LastError | null

Error information when processing fails.

code: string

A machine-readable error code.

maxLength64
message: string

A human-readable description of the error.

maxLength1024
sheet_names?: Array<string>

List of sheet names included in this conversion.

table_count?: number | null

Number of tables extracted from the workbook. Only present when status is 'completed'.

minimum0

Structured SheetsTables

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"