Sheets
Create Spreadsheet Job
List Spreadsheet Jobs
Get Spreadsheet Job
Get Result Region
Delete Spreadsheet Job
ModelsExpand Collapse
SheetsJob = object { 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: optional string
A1 notation of the range to extract a single region from. If None, the entire sheet is used.
flatten_hierarchical_tables: optional boolean
Return a flattened dataframe when a detected table is recognized as hierarchical.
generate_additional_metadata: optional boolean
Whether to generate additional metadata (title, description) for each extracted region.
include_hidden_cells: optional boolean
Whether to include hidden cells when extracting regions from the spreadsheet.
sheet_names: optional array of string
The names of the sheets to extract regions from. If empty, all sheets will be processed.
table_merge_sensitivity: optional "strong" or "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).
use_experimental_processing: optional boolean
Enables experimental processing. Accuracy may be impacted.
created_at: string
When the job was created
file_id: string
The ID of the input file
project_id: string
The ID of the project
The status of the parsing job
updated_at: string
When the job was last updated
user_id: string
The ID of the user
errors: optional array of string
Any errors encountered
Schema for a file.
id: string
Unique identifier
project_id: string
The ID of the project that the file belongs to
created_at: optional string
Creation datetime
data_source_id: optional string
The ID of the data source that the file belongs to
expires_at: optional string
The expiration date for the file. Files past this date can be deleted.
external_file_id: optional string
The ID of the file in the external system
file_size: optional number
Size of the file in bytes
file_type: optional string
File type (e.g. pdf, docx, etc.)
last_modified_at: optional string
The last modified time of the file
permission_info: optional map[map[unknown] or array of unknown or string or 2 more]
Permission information for the file
purpose: optional string
The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify')
resource_info: optional map[map[unknown] or array of unknown or string or 2 more]
Resource information for the file
updated_at: optional string
Update datetime
regions: optional array of object { location, region_type, sheet_name, 3 more }
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: optional string
Generated description for the region
region_id: optional string
Unique identifier for this region within the file
title: optional string
Generated title for the region
success: optional boolean
Whether the job completed successfully
worksheet_metadata: optional array of object { sheet_name, description, title }
Metadata for each processed worksheet (populated when job is complete)
sheet_name: string
Name of the worksheet
description: optional string
Generated description of the worksheet
title: optional string
Generated title for the worksheet
SheetsParsingConfig = object { extraction_range, flatten_hierarchical_tables, generate_additional_metadata, 4 more }
Configuration for spreadsheet parsing and region extraction
extraction_range: optional string
A1 notation of the range to extract a single region from. If None, the entire sheet is used.
flatten_hierarchical_tables: optional boolean
Return a flattened dataframe when a detected table is recognized as hierarchical.
generate_additional_metadata: optional boolean
Whether to generate additional metadata (title, description) for each extracted region.
include_hidden_cells: optional boolean
Whether to include hidden cells when extracting regions from the spreadsheet.
sheet_names: optional array of string
The names of the sheets to extract regions from. If empty, all sheets will be processed.
table_merge_sensitivity: optional "strong" or "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).
use_experimental_processing: optional boolean
Enables experimental processing. Accuracy may be impacted.