Skip to content
Get started

Structured Sheets

List structured sheets
GET/v1/structured-sheets
Create structured sheets
POST/v1/structured-sheets
Delete structured sheets
DELETE/v1/structured-sheets/{structured_sheets_id}
Retrieve structured sheets
GET/v1/structured-sheets/{structured_sheets_id}
ModelsExpand Collapse
StructuredSheetResponse = object { id, created_at, file_id, 6 more }

Response representing a structured sheets conversion job.

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

id: string

The unique identifier for this structured sheets conversion.

created_at: string

The timestamp when the conversion was started.

formatdate-time
file_id: string

The unique identifier for the source file.

status: "pending" or "queued" or "in_progress" or 3 more

The current processing status.

Accepts one of the following:
"pending"
"queued"
"in_progress"
"completed"
"failed"
"cancelled"
updated_at: string

The timestamp when the conversion was last updated.

formatdate-time
exports_available: optional array of string

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

last_error: optional object { code, message }

Error information when processing fails.

code: string

A machine-readable error code.

maxLength64
message: string

A human-readable description of the error.

maxLength1024
object: optional "structured_sheet"

The object type, which is always 'structured_sheet'.

sheet_names: optional array of string

List of sheet names included in this conversion.

Structured SheetsExports

Download SQLite export
GET/v1/structured-sheets/{structured_sheets_id}/exports/sqlite