Sheets

Create Spreadsheet Job

client.beta.sheets.create(, ?): SheetsJob { id, config, created_at, 10 more }

POST/api/v1/beta/sheets/jobs

List Spreadsheet Jobs

client.beta.sheets.list(?, ?): PaginatedCursor<SheetsJob { id, config, created_at, 10 more } >

GET/api/v1/beta/sheets/jobs

Get Spreadsheet Job

client.beta.sheets.get(, ?, ?): SheetsJob { id, config, created_at, 10 more }

GET/api/v1/beta/sheets/jobs/{spreadsheet_job_id}

Get Result Region

client.beta.sheets.getResultTable(, , ?): PresignedURL { expires_at, url, form_fields }

GET/api/v1/beta/sheets/jobs/{spreadsheet_job_id}/regions/{region_id}/result/{region_type}

Delete Spreadsheet Job

client.beta.sheets.deleteJob(, ?, ?): SheetDeleteJobResponse

DELETE/api/v1/beta/sheets/jobs/{spreadsheet_job_id}

ModelsExpand Collapse

SheetsJob { id, config, created_at, 10 more }

A spreadsheet parsing job

id: string

The ID of the job

config: SheetsParsingConfig { extraction_range, flatten_hierarchical_tables, generate_additional_metadata, 4 more }

Configuration for the parsing job

extraction_range?: string | null

A1 notation of the range to extract a single region from. If None, the entire sheet is used.

flatten_hierarchical_tables?: boolean

Return a flattened dataframe when a detected table is recognized as hierarchical.

generate_additional_metadata?: boolean

Whether to generate additional metadata (title, description) for each extracted region.

include_hidden_cells?: boolean

Whether to include hidden cells when extracting regions from the spreadsheet.

sheet_names?: Array<string> | null

The names of the sheets to extract regions from. If empty, all sheets will be processed.

table_merge_sensitivity?: "strong" | "weak"

Influences how likely similar-looking regions are merged into a single table. Useful for spreadsheets that either have sparse tables (strong merging) or many distinct tables close together (weak merging).

Accepts one of the following:

"strong"

"weak"

use_experimental_processing?: boolean

Enables experimental processing. Accuracy may be impacted.

created_at: string

When the job was created

file_id: string | null

The ID of the input file

formatuuid

project_id: string

The ID of the project

formatuuid

status: StatusEnum

The status of the parsing job

Accepts one of the following:

"PENDING"

"SUCCESS"

"ERROR"

"PARTIAL_SUCCESS"

"CANCELLED"

updated_at: string

When the job was last updated

user_id: string

The ID of the user

errors?: Array<string>

Any errors encountered

Deprecatedfile?: File { id, name, project_id, 11 more } | null

Schema for a file.

id: string

Unique identifier

formatuuid

name: string

project_id: string

The ID of the project that the file belongs to

formatuuid

created_at?: string | null

Creation datetime

formatdate-time

data_source_id?: string | null

The ID of the data source that the file belongs to

formatuuid

expires_at?: string | null

The expiration date for the file. Files past this date can be deleted.

formatdate-time

external_file_id?: string | null

The ID of the file in the external system

file_size?: number | null

Size of the file in bytes

minimum0

file_type?: string | null

File type (e.g. pdf, docx, etc.)

maxLength3000

minLength1

last_modified_at?: string | null

The last modified time of the file

formatdate-time

Permission information for the file

Accepts one of the following:

Record<string, unknown>

Array<unknown>

string

number

boolean

purpose?: string | null

The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify')

Resource information for the file

Accepts one of the following:

Record<string, unknown>

Array<unknown>

string

number

boolean

updated_at?: string | null

Update datetime

formatdate-time

regions?: Array<Region>

All extracted regions (populated when job is complete)

location: string

Location of the region in the spreadsheet

region_type: string

Type of the extracted region

sheet_name: string

Worksheet name where region was found

description?: string | null

Generated description for the region

region_id?: string

Unique identifier for this region within the file

title?: string | null

Generated title for the region

success?: boolean | null

Whether the job completed successfully

worksheet_metadata?: Array<WorksheetMetadata>

Metadata for each processed worksheet (populated when job is complete)

sheet_name: string

Name of the worksheet

description?: string | null

Generated description of the worksheet

title?: string | null

Generated title for the worksheet

SheetsParsingConfig { extraction_range, flatten_hierarchical_tables, generate_additional_metadata, 4 more }

Configuration for spreadsheet parsing and region extraction

extraction_range?: string | null

A1 notation of the range to extract a single region from. If None, the entire sheet is used.

flatten_hierarchical_tables?: boolean

Return a flattened dataframe when a detected table is recognized as hierarchical.

generate_additional_metadata?: boolean

Whether to generate additional metadata (title, description) for each extracted region.

include_hidden_cells?: boolean

Whether to include hidden cells when extracting regions from the spreadsheet.

sheet_names?: Array<string> | null

The names of the sheets to extract regions from. If empty, all sheets will be processed.

table_merge_sensitivity?: "strong" | "weak"

Accepts one of the following:

"strong"

"weak"

use_experimental_processing?: boolean

Enables experimental processing. Accuracy may be impacted.