Sign in

v10

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-02-05141768.5 KB
Structured Sheets

Create structured sheet

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.

post/v1/structured-sheets

Request body

file_idstring required

The unique identifier of the file to convert.

sheet_namesstring[] nullable

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

Example request

{
  "file_id": "file_01h45ytscbebyvny4gc8cr8ma2",
  "sheet_names": [
    "Sheet1",
    "Financials"
  ]
}

Response

Conversion job accepted and started

idstring required

The unique identifier for this structured sheet conversion.

object'structured_sheet' required

The object type, which is always 'structured_sheet'.

file_idstring required

The unique identifier for the source file.

status'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled' required

Status of processing for structured sheets.

  • queued: Job is queued and waiting to be processed
  • in_progress: Job is currently being processed
  • completed: Processing finished successfully
  • failed: Processing encountered an error
  • cancelled: Processing was cancelled by the user
table_countinteger nullable

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

created_atstring date-time required

The timestamp when the conversion was started.

updated_atstring date-time required

The timestamp when the conversion was last updated.

sheet_namesstring[]

List of sheet names included in this conversion.

Example response

{
  "created_at": "2024-01-15T10:30:00Z",
  "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "object": "structured_sheet",
  "sheet_names": [
    "Sheet1",
    "Financials"
  ],
  "status": "completed",
  "table_count": 6,
  "updated_at": "2024-01-15T10:35:00Z"
}