API Reference

Beta

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Sheets

Create Spreadsheet Job

Deprecated

SheetsJob beta().sheets().create(SheetCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v1/beta/sheets/jobs

List Spreadsheet Jobs

Deprecated

SheetListPage beta().sheets().list(SheetListParamsparams = SheetListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/beta/sheets/jobs

Get Spreadsheet Job

Deprecated

SheetsJob beta().sheets().get(SheetGetParamsparams = SheetGetParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

Get Result Region

Deprecated

PresignedUrl beta().sheets().getResultTable(SheetGetResultTableParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Delete Spreadsheet Job

Deprecated

JsonValue beta().sheets().deleteJob(SheetDeleteJobParamsparams = SheetDeleteJobParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

ModelsExpand Collapse

class SheetsJob:

A spreadsheet parsing job.

String id

The ID of the job

SheetsParsingConfig configuration

Configuration applied to the parsing job (inline or resolved from a saved preset).

Optional<String> extractionRange

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

Optional<Boolean> flattenHierarchicalTables

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

Optional<Boolean> generateAdditionalMetadata

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

Optional<Boolean> includeHiddenCells

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

Optional<List<String>> sheetNames

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

Optional<String> specialization

Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline.

Optional<TableMergeSensitivity> tableMergeSensitivity

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).

One of the following:

STRONG("strong")

WEAK("weak")

Optional<Boolean> useExperimentalProcessing

Enables experimental processing. Accuracy may be impacted.

String createdAt

When the job was created

Optional<String> fileId

The ID of the input file

formatuuid

String projectId

The ID of the project

formatuuid

Status status

The status of the parsing job

One of the following:

PENDING("PENDING")

SUCCESS("SUCCESS")

ERROR("ERROR")

PARTIAL_SUCCESS("PARTIAL_SUCCESS")

CANCELLED("CANCELLED")

String updatedAt

When the job was last updated

String userId

The ID of the user

DeprecatedOptional<SheetsParsingConfig> config

Configuration for spreadsheet parsing and region extraction

Optional<String> extractionRange

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

Optional<Boolean> flattenHierarchicalTables

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

Optional<Boolean> generateAdditionalMetadata

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

Optional<Boolean> includeHiddenCells

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

Optional<List<String>> sheetNames

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

Optional<String> specialization

Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline.

Optional<TableMergeSensitivity> tableMergeSensitivity

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).

One of the following:

STRONG("strong")

WEAK("weak")

Optional<Boolean> useExperimentalProcessing

Enables experimental processing. Accuracy may be impacted.

Optional<String> configurationId

The saved product configuration ID used at create time, if any.

Optional<List<String>> errors

Any errors encountered

DeprecatedOptional<File> file

Schema for a file.

String id

Unique identifier

formatuuid

String name

String projectId

The ID of the project that the file belongs to

formatuuid

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<String> dataSourceId

The ID of the data source that the file belongs to

formatuuid

Optional<LocalDateTime> expiresAt

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

formatdate-time

Optional<String> externalFileId

The ID of the file in the external system

Optional<Long> fileSize

Size of the file in bytes

minimum0

Optional<String> fileType

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

maxLength3000

minLength1

Optional<LocalDateTime> lastModifiedAt

The last modified time of the file

formatdate-time

Optional<PermissionInfo> permissionInfo

Permission information for the file

One of the following:

class UnionMember0:

List<JsonValue>

String

double

boolean

Optional<String> purpose

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

Optional<ResourceInfo> resourceInfo

Resource information for the file

One of the following:

class UnionMember0:

List<JsonValue>

String

double

boolean

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Optional<MetadataStateTransitions> metadataStateTransitions

Per-status entry timestamps. Returned only when requested via ?expand=metadata_state_transitions.

Optional<Parameters> parameters

Job-time parameters such as webhook configurations.

Optional<List<WebhookConfiguration>> webhookConfigurations

Webhook configurations for job status notifications.

Optional<List<WebhookEvent>> webhookEvents

Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.

One of the following:

EXTRACT_PENDING("extract.pending")

EXTRACT_SUCCESS("extract.success")

EXTRACT_ERROR("extract.error")

EXTRACT_PARTIAL_SUCCESS("extract.partial_success")

EXTRACT_CANCELLED("extract.cancelled")

PARSE_PENDING("parse.pending")

PARSE_RUNNING("parse.running")

PARSE_SUCCESS("parse.success")

PARSE_ERROR("parse.error")

PARSE_PARTIAL_SUCCESS("parse.partial_success")

PARSE_CANCELLED("parse.cancelled")

CLASSIFY_PENDING("classify.pending")

CLASSIFY_RUNNING("classify.running")

CLASSIFY_SUCCESS("classify.success")

CLASSIFY_ERROR("classify.error")

CLASSIFY_PARTIAL_SUCCESS("classify.partial_success")

CLASSIFY_CANCELLED("classify.cancelled")

SHEETS_PENDING("sheets.pending")

SHEETS_SUCCESS("sheets.success")

SHEETS_ERROR("sheets.error")

SHEETS_PARTIAL_SUCCESS("sheets.partial_success")

SHEETS_CANCELLED("sheets.cancelled")

SPLIT_PENDING("split.pending")

SPLIT_PROCESSING("split.processing")

SPLIT_SUCCESS("split.success")

SPLIT_ERROR("split.error")

SPLIT_CANCELLED("split.cancelled")

UNMAPPED_EVENT("unmapped_event")

Optional<WebhookHeaders> webhookHeaders

Custom HTTP headers sent with each webhook request (e.g. auth tokens)

Optional<String> webhookOutputFormat

Response format sent to the webhook: ‘string’ (default) or ‘json’

Optional<String> webhookSigningSecret

Shared signing secret used to sign webhook deliveries. When set, each request includes an HMAC-SHA256 signature of the request body in the ‘LC-Signature’ header (value ‘sha256=’). Recompute the HMAC over the raw request body with this secret to verify the delivery is authentic.

Optional<String> webhookUrl

URL to receive webhook POST notifications

Optional<List<Region>> regions

All extracted regions (populated when job is complete)

String location

Location of the region in the spreadsheet

String regionType

Type of the extracted region

String sheetName

Worksheet name where region was found

Optional<String> description

Generated description for the region

Optional<String> regionId

Unique identifier for this region within the file

Optional<String> title

Generated title for the region

Optional<Boolean> success

Whether the job completed successfully

Optional<List<WorksheetMetadata>> worksheetMetadata

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

String sheetName

Name of the worksheet

Optional<String> description

Generated description of the worksheet

Optional<String> title

Generated title for the worksheet

class SheetsParsingConfig:

Configuration for spreadsheet parsing and region extraction

Optional<String> extractionRange

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

Optional<Boolean> flattenHierarchicalTables

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

Optional<Boolean> generateAdditionalMetadata

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

Optional<Boolean> includeHiddenCells

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

Optional<List<String>> sheetNames

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

Optional<String> specialization

Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline.

Optional<TableMergeSensitivity> tableMergeSensitivity

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).

One of the following:

STRONG("strong")

WEAK("weak")

Optional<Boolean> useExperimentalProcessing

Enables experimental processing. Accuracy may be impacted.