Structured Sheets

List structured sheets

client.structuredSheets.list(?, ?): CursorIDPage<StructuredSheetResponse { id, created_at, file_id, 6 more } >

GET/v1/structured-sheets

Create structured sheets

client.structuredSheets.create(, ?): StructuredSheetResponse { id, created_at, file_id, 6 more }

POST/v1/structured-sheets

Delete structured sheets

client.structuredSheets.delete(, ?): void

DELETE/v1/structured-sheets/{structured_sheets_id}

Retrieve structured sheets

client.structuredSheets.retrieve(, ?): StructuredSheetResponse { id, created_at, file_id, 6 more }

GET/v1/structured-sheets/{structured_sheets_id}

ModelsExpand Collapse

StructuredSheetResponse { 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" | "queued" | "in_progress" | 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?: Array<string>

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

last_error?: LastError | null

Error information when processing fails.

code: string

A machine-readable error code.

maxLength64

message: string

A human-readable description of the error.

maxLength1024

object?: "structured_sheet"

The object type, which is always 'structured_sheet'.

sheet_names?: Array<string>

List of sheet names included in this conversion.

Structured SheetsExports

Download SQLite export

client.structuredSheets.exports.downloadSqlite(, ?): Response

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