Skip to content
DeepTable
Get started
API Reference
Structured Sheets

Download structured sheet export

client.structuredSheets.download(stringstructuredSheetID, StructuredSheetDownloadParams { format } query?, RequestOptionsoptions?): Response
GET/v1/structured-sheets/{structured_sheet_id}/download

Download the structured data in the specified format. Only available when conversion status is 'completed'.

Available formats:

  • sqlite: SQLite database containing all extracted tables
  • cell_labels: CSV file with cell-level semantic labels
ParametersExpand Collapse
structuredSheetID: string

The unique identifier of the structured sheet conversion.

query: StructuredSheetDownloadParams { format }
format?: "sqlite" | "cell_labels"

The export format to download.

One of the following:
"sqlite"
"cell_labels"
ReturnsExpand Collapse
unnamed_schema_4 = Response

Download structured sheet export

import DeepTable from '@deeptable/deeptable';

const client = new DeepTable({
  apiKey: process.env['DEEPTABLE_API_KEY'], // This is the default and can be omitted
});

const response = await client.structuredSheets.download('ss_01kfxgjd94fn9stqm42nejb627');

console.log(response);

const content = await response.blob();
console.log(content);
Returns Examples