Skip to content
DeepTable
Get started
API Reference
Structured Sheets

Create structured sheet

structured_sheets.create(StructuredSheetCreateParams**kwargs) -> StructuredSheetResponse
POST/v1/structured-sheets

Start converting a spreadsheet workbook into structured data. This initiates an asynchronous conversion process. Poll the returned resource using the id to check completion status.

ParametersExpand Collapse
file_id: str

The unique identifier of the file to convert.

sheet_names: Optional[SequenceNotStr[str]]

List of sheet names to convert. If None, all sheets will be converted.

ReturnsExpand Collapse
class StructuredSheetResponse: …

Response representing a structured sheet conversion job.

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

id: str

The unique identifier for this structured sheet conversion.

created_at: datetime

The timestamp when the conversion was started.

formatdate-time
file_id: str

The unique identifier for the source file.

object: Literal["structured_sheet"]

The object type, which is always 'structured_sheet'.

status: Literal["queued", "in_progress", "completed", 2 more]

The current processing status.

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

The timestamp when the conversion was last updated.

formatdate-time
last_error: Optional[LastError]

Error information when processing fails.

code: str

A machine-readable error code.

maxLength64
message: str

A human-readable description of the error.

maxLength1024
sheet_names: Optional[List[str]]

List of sheet names included in this conversion.

table_count: Optional[int]

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

minimum0

Create structured sheet

import os
from deeptable import DeepTable

client = DeepTable(
    api_key=os.environ.get("DEEPTABLE_API_KEY"),  # This is the default and can be omitted
)
structured_sheet_response = client.structured_sheets.create(
    file_id="file_01h45ytscbebyvny4gc8cr8ma2",
)
print(structured_sheet_response.id)
{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "created_at": "2024-01-15T10:30:00Z",
  "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
  "object": "structured_sheet",
  "status": "completed",
  "updated_at": "2024-01-15T10:35:00Z",
  "last_error": {
    "code": "invalid_file_format",
    "message": "The uploaded file is not a valid Excel spreadsheet."
  },
  "sheet_names": [
    "Sheet1",
    "Financials"
  ],
  "table_count": 6
}
Returns Examples
{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "created_at": "2024-01-15T10:30:00Z",
  "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
  "object": "structured_sheet",
  "status": "completed",
  "updated_at": "2024-01-15T10:35:00Z",
  "last_error": {
    "code": "invalid_file_format",
    "message": "The uploaded file is not a valid Excel spreadsheet."
  },
  "sheet_names": [
    "Sheet1",
    "Financials"
  ],
  "table_count": 6
}