Skip to content
Get started

Download structured sheet export

structured_sheets.download(strstructured_sheet_id, StructuredSheetDownloadParams**kwargs) -> BinaryResponseContent
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
structured_sheet_id: str

The unique identifier of the structured sheet conversion.

format: Optional[Literal["sqlite", "cell_labels"]]

The export format to download.

One of the following:
"sqlite"
"cell_labels"
ReturnsExpand Collapse
BinaryResponseContent

Download structured sheet export

import os
from deeptable import DeepTable

client = DeepTable(
    api_key=os.environ.get("DEEPTABLE_API_KEY"),  # This is the default and can be omitted
)
response = client.structured_sheets.download(
    structured_sheet_id="ss_01kfxgjd94fn9stqm42nejb627",
)
print(response)
content = response.read()
print(content)
Returns Examples