Skip to content
DeepTable
Get started
API Reference
Structured Sheets

Create structured sheet

$ deeptable structured-sheets create
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: string

The unique identifier of the file to convert.

--sheet-name: optional array of string

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

ReturnsExpand Collapse
structured_sheet_response: object { 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.

file_id: string

The unique identifier for the source file.

object: "structured_sheet"

The object type, which is always 'structured_sheet'.

"structured_sheet"
status: "queued" or "in_progress" or "completed" or 2 more

The current processing status.

"queued"
"in_progress"
"completed"
"failed"
"cancelled"
updated_at: string

The timestamp when the conversion was last updated.

last_error: optional object { code, message }

Error information when processing fails.

code: string

A machine-readable error code.

message: string

A human-readable description of the error.

sheet_names: optional array of string

List of sheet names included in this conversion.

table_count: optional number

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

Create structured sheet

deeptable structured-sheets create \
  --api-key 'My API Key' \
  --file-id file_01h45ytscbebyvny4gc8cr8ma2
{
  "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
}