Structured Sheets

List structured sheets

structured_sheets.list() -> SyncCursorIDPage[StructuredSheetResponse]

GET/v1/structured-sheets

Create structured sheets

structured_sheets.create() -> StructuredSheetResponse

POST/v1/structured-sheets

Delete structured sheets

structured_sheets.delete()

DELETE/v1/structured-sheets/{structured_sheets_id}

Retrieve structured sheets

structured_sheets.retrieve() -> StructuredSheetResponse

GET/v1/structured-sheets/{structured_sheets_id}

ModelsExpand Collapse

class StructuredSheetResponse: …

Response representing a structured sheets conversion job.

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

id: str

The unique identifier for this structured sheets conversion.

created_at: datetime

The timestamp when the conversion was started.

formatdate-time

file_id: str

The unique identifier for the source file.

status: Literal["pending", "queued", "in_progress", 3 more]

The current processing status.

Accepts one of the following:

"pending"

"queued"

"in_progress"

"completed"

"failed"

"cancelled"

updated_at: datetime

The timestamp when the conversion was last updated.

formatdate-time

exports_available: Optional[List[str]]

List of export formats available for download (e.g., ['sqlite']).

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

object: Optional[Literal["structured_sheet"]]

The object type, which is always 'structured_sheet'.

sheet_names: Optional[List[str]]

List of sheet names included in this conversion.

Structured SheetsExports

Download SQLite export

structured_sheets.exports.download_sqlite() -> BinaryResponseContent

GET/v1/structured-sheets/{structured_sheets_id}/exports/sqlite