# Sheets ## Create Spreadsheet Job `client.sheets.create(SheetCreateParamsparams, RequestOptionsoptions?): SheetsJob` **post** `/api/v1/sheets/jobs` Create a spreadsheet parsing job. Provide at most one of `configuration` (an inline parsing configuration) or `configuration_id` (a saved configuration preset). If neither is provided, a default configuration is used. Optionally include `webhook_configurations` to receive `sheets.*` status notifications. ### Parameters - `params: SheetCreateParams` - `file_id: string` Body param: The ID of the file to parse - `organization_id?: string | null` Query param - `project_id?: string | null` Query param - `config?: SheetsParsingConfig | null` Body param: 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` Deprecated: controlled by `tier`. Whether to generate additional metadata (title, description) for each extracted region. Honored only on `agentic`. - `include_hidden_cells?: boolean` Whether to include hidden cells when extracting regions from the spreadsheet. - `sheet_names?: Array | null` The names of the sheets to extract regions from. If empty, all sheets will be processed. - `specialization?: string | null` Deprecated: controlled by `tier`. Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. Honored only on `agentic`. - `table_merge_sensitivity?: "strong" | "weak"` Deprecated: controlled by `tier`. Influences how likely similar-looking regions are merged into a single table. Honored only on `agentic`. - `"strong"` - `"weak"` - `tier?: "agentic" | "cost_effective"` Spreadsheet extraction tier. `cost_effective` uses the rule-based/ML-only pipeline; `agentic` uses the full pipeline. - `"agentic"` - `"cost_effective"` - `use_experimental_processing?: boolean` Deprecated: controlled by `tier`. Enables experimental processing. Honored only on `agentic`. - `configuration?: SheetsParsingConfig | null` Body param: Configuration for spreadsheet parsing and region extraction - `configuration_id?: string | null` Body param: Saved configuration ID - `webhook_configurations?: Array | null` Body param: Outbound webhook endpoints to notify on job status changes - `webhook_events?: Array<"classify.cancelled" | "classify.error" | "classify.partial_success" | 25 more> | null` Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered. - `"classify.cancelled"` - `"classify.error"` - `"classify.partial_success"` - `"classify.pending"` - `"classify.running"` - `"classify.success"` - `"extract.cancelled"` - `"extract.error"` - `"extract.partial_success"` - `"extract.pending"` - `"extract.success"` - `"parse.cancelled"` - `"parse.error"` - `"parse.partial_success"` - `"parse.pending"` - `"parse.running"` - `"parse.success"` - `"sheets.cancelled"` - `"sheets.error"` - `"sheets.partial_success"` - `"sheets.pending"` - `"sheets.success"` - `"split.cancelled"` - `"split.error"` - `"split.pending"` - `"split.processing"` - `"split.success"` - `"unmapped_event"` - `webhook_headers?: Record | null` Custom HTTP headers sent with each webhook request (e.g. auth tokens) - `webhook_output_format?: string | null` Response format sent to the webhook: 'string' (default) or 'json' - `webhook_signing_secret?: string | null` 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. - `webhook_url?: string | null` URL to receive webhook POST notifications ### Returns - `SheetsJob` A spreadsheet parsing job. - `id: string` The ID of the job - `configuration: SheetsParsingConfig` Configuration applied to the parsing job (inline or resolved from a saved preset). - `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` Deprecated: controlled by `tier`. Whether to generate additional metadata (title, description) for each extracted region. Honored only on `agentic`. - `include_hidden_cells?: boolean` Whether to include hidden cells when extracting regions from the spreadsheet. - `sheet_names?: Array | null` The names of the sheets to extract regions from. If empty, all sheets will be processed. - `specialization?: string | null` Deprecated: controlled by `tier`. Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. Honored only on `agentic`. - `table_merge_sensitivity?: "strong" | "weak"` Deprecated: controlled by `tier`. Influences how likely similar-looking regions are merged into a single table. Honored only on `agentic`. - `"strong"` - `"weak"` - `tier?: "agentic" | "cost_effective"` Spreadsheet extraction tier. `cost_effective` uses the rule-based/ML-only pipeline; `agentic` uses the full pipeline. - `"agentic"` - `"cost_effective"` - `use_experimental_processing?: boolean` Deprecated: controlled by `tier`. Enables experimental processing. Honored only on `agentic`. - `created_at: string` When the job was created - `file_id: string | null` The ID of the input file - `project_id: string` The ID of the project - `status: "CANCELLED" | "ERROR" | "PARTIAL_SUCCESS" | 2 more` The status of the parsing job - `"CANCELLED"` - `"ERROR"` - `"PARTIAL_SUCCESS"` - `"PENDING"` - `"SUCCESS"` - `updated_at: string` When the job was last updated - `user_id: string` The ID of the user - `config?: SheetsParsingConfig | null` Configuration for spreadsheet parsing and region extraction - `configuration_id?: string | null` The saved product configuration ID used at create time, if any. - `errors?: Array` Any errors encountered - `file?: File | null` Schema for a file. - `id: string` Unique identifier - `name: string` - `project_id: string` The ID of the project that the file belongs to - `created_at?: string | null` Creation datetime - `data_source_id?: string | null` The ID of the data source that the file belongs to - `expires_at?: string | null` The expiration date for the file. Files past this date can be deleted. - `external_file_id?: string | null` The ID of the file in the external system - `file_size?: number | null` Size of the file in bytes - `file_type?: string | null` File type (e.g. pdf, docx, etc.) - `last_modified_at?: string | null` The last modified time of the file - `permission_info?: Record | Array | string | 2 more | null> | null` Permission information for the file - `Record` - `Array` - `string` - `number` - `boolean` - `purpose?: string | null` The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify') - `resource_info?: Record | Array | string | 2 more | null> | null` Resource information for the file - `Record` - `Array` - `string` - `number` - `boolean` - `updated_at?: string | null` Update datetime - `metadata_state_transitions?: Record | null` Per-status entry timestamps. Returned only when requested via `?expand=metadata_state_transitions`. - `parameters?: Parameters` Job-time parameters such as webhook configurations. - `webhook_configurations?: Array | null` Webhook configurations for job status notifications. - `webhook_events?: Array<"classify.cancelled" | "classify.error" | "classify.partial_success" | 25 more> | null` Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered. - `"classify.cancelled"` - `"classify.error"` - `"classify.partial_success"` - `"classify.pending"` - `"classify.running"` - `"classify.success"` - `"extract.cancelled"` - `"extract.error"` - `"extract.partial_success"` - `"extract.pending"` - `"extract.success"` - `"parse.cancelled"` - `"parse.error"` - `"parse.partial_success"` - `"parse.pending"` - `"parse.running"` - `"parse.success"` - `"sheets.cancelled"` - `"sheets.error"` - `"sheets.partial_success"` - `"sheets.pending"` - `"sheets.success"` - `"split.cancelled"` - `"split.error"` - `"split.pending"` - `"split.processing"` - `"split.success"` - `"unmapped_event"` - `webhook_headers?: Record | null` Custom HTTP headers sent with each webhook request (e.g. auth tokens) - `webhook_output_format?: string | null` Response format sent to the webhook: 'string' (default) or 'json' - `webhook_signing_secret?: string | null` 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. - `webhook_url?: string | null` URL to receive webhook POST notifications - `regions?: Array` 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` 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 ### Example ```typescript import LlamaCloud from '@llamaindex/llama-cloud'; const client = new LlamaCloud({ apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted }); const sheetsJob = await client.sheets.create({ file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }); console.log(sheetsJob.id); ``` #### Response ```json { "id": "id", "configuration": { "extraction_range": "extraction_range", "flatten_hierarchical_tables": true, "generate_additional_metadata": true, "include_hidden_cells": true, "sheet_names": [ "string" ], "specialization": "specialization", "table_merge_sensitivity": "strong", "tier": "agentic", "use_experimental_processing": true }, "created_at": "created_at", "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "CANCELLED", "updated_at": "updated_at", "user_id": "user_id", "config": { "extraction_range": "extraction_range", "flatten_hierarchical_tables": true, "generate_additional_metadata": true, "include_hidden_cells": true, "sheet_names": [ "string" ], "specialization": "specialization", "table_merge_sensitivity": "strong", "tier": "agentic", "use_experimental_processing": true }, "configuration_id": "configuration_id", "errors": [ "string" ], "file": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "name": "x", "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "expires_at": "2019-12-27T18:11:19.117Z", "external_file_id": "external_file_id", "file_size": 0, "file_type": "x", "last_modified_at": "2019-12-27T18:11:19.117Z", "permission_info": { "foo": { "foo": "bar" } }, "purpose": "purpose", "resource_info": { "foo": { "foo": "bar" } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "metadata_state_transitions": { "foo": "bar" }, "parameters": { "webhook_configurations": [ { "webhook_events": [ "parse.success", "parse.error" ], "webhook_headers": { "Authorization": "Bearer sk-..." }, "webhook_output_format": "json", "webhook_signing_secret": "whsec_...", "webhook_url": "https://example.com/webhooks/llamacloud" } ] }, "regions": [ { "location": "location", "region_type": "region_type", "sheet_name": "sheet_name", "description": "description", "region_id": "region_id", "title": "title" } ], "success": true, "worksheet_metadata": [ { "sheet_name": "sheet_name", "description": "description", "title": "title" } ] } ``` ## List Spreadsheet Jobs `client.sheets.list(SheetListParamsquery?, RequestOptionsoptions?): PaginatedCursor` **get** `/api/v1/sheets/jobs` List spreadsheet parsing jobs. ### Parameters - `query: SheetListParams` - `configuration_id?: string | null` Filter by saved configuration ID - `created_at_on_or_after?: string | null` Include items created at or after this timestamp (inclusive) - `created_at_on_or_before?: string | null` Include items created at or before this timestamp (inclusive) - `include_results?: boolean` - `job_ids?: Array | null` Filter by specific job IDs - `organization_id?: string | null` - `page_size?: number | null` - `page_token?: string | null` - `project_id?: string | null` - `status?: "CANCELLED" | "ERROR" | "PARTIAL_SUCCESS" | 2 more | null` Filter by job status - `"CANCELLED"` - `"ERROR"` - `"PARTIAL_SUCCESS"` - `"PENDING"` - `"SUCCESS"` ### Returns - `SheetsJob` A spreadsheet parsing job. - `id: string` The ID of the job - `configuration: SheetsParsingConfig` Configuration applied to the parsing job (inline or resolved from a saved preset). - `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` Deprecated: controlled by `tier`. Whether to generate additional metadata (title, description) for each extracted region. Honored only on `agentic`. - `include_hidden_cells?: boolean` Whether to include hidden cells when extracting regions from the spreadsheet. - `sheet_names?: Array | null` The names of the sheets to extract regions from. If empty, all sheets will be processed. - `specialization?: string | null` Deprecated: controlled by `tier`. Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. Honored only on `agentic`. - `table_merge_sensitivity?: "strong" | "weak"` Deprecated: controlled by `tier`. Influences how likely similar-looking regions are merged into a single table. Honored only on `agentic`. - `"strong"` - `"weak"` - `tier?: "agentic" | "cost_effective"` Spreadsheet extraction tier. `cost_effective` uses the rule-based/ML-only pipeline; `agentic` uses the full pipeline. - `"agentic"` - `"cost_effective"` - `use_experimental_processing?: boolean` Deprecated: controlled by `tier`. Enables experimental processing. Honored only on `agentic`. - `created_at: string` When the job was created - `file_id: string | null` The ID of the input file - `project_id: string` The ID of the project - `status: "CANCELLED" | "ERROR" | "PARTIAL_SUCCESS" | 2 more` The status of the parsing job - `"CANCELLED"` - `"ERROR"` - `"PARTIAL_SUCCESS"` - `"PENDING"` - `"SUCCESS"` - `updated_at: string` When the job was last updated - `user_id: string` The ID of the user - `config?: SheetsParsingConfig | null` Configuration for spreadsheet parsing and region extraction - `configuration_id?: string | null` The saved product configuration ID used at create time, if any. - `errors?: Array` Any errors encountered - `file?: File | null` Schema for a file. - `id: string` Unique identifier - `name: string` - `project_id: string` The ID of the project that the file belongs to - `created_at?: string | null` Creation datetime - `data_source_id?: string | null` The ID of the data source that the file belongs to - `expires_at?: string | null` The expiration date for the file. Files past this date can be deleted. - `external_file_id?: string | null` The ID of the file in the external system - `file_size?: number | null` Size of the file in bytes - `file_type?: string | null` File type (e.g. pdf, docx, etc.) - `last_modified_at?: string | null` The last modified time of the file - `permission_info?: Record | Array | string | 2 more | null> | null` Permission information for the file - `Record` - `Array` - `string` - `number` - `boolean` - `purpose?: string | null` The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify') - `resource_info?: Record | Array | string | 2 more | null> | null` Resource information for the file - `Record` - `Array` - `string` - `number` - `boolean` - `updated_at?: string | null` Update datetime - `metadata_state_transitions?: Record | null` Per-status entry timestamps. Returned only when requested via `?expand=metadata_state_transitions`. - `parameters?: Parameters` Job-time parameters such as webhook configurations. - `webhook_configurations?: Array | null` Webhook configurations for job status notifications. - `webhook_events?: Array<"classify.cancelled" | "classify.error" | "classify.partial_success" | 25 more> | null` Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered. - `"classify.cancelled"` - `"classify.error"` - `"classify.partial_success"` - `"classify.pending"` - `"classify.running"` - `"classify.success"` - `"extract.cancelled"` - `"extract.error"` - `"extract.partial_success"` - `"extract.pending"` - `"extract.success"` - `"parse.cancelled"` - `"parse.error"` - `"parse.partial_success"` - `"parse.pending"` - `"parse.running"` - `"parse.success"` - `"sheets.cancelled"` - `"sheets.error"` - `"sheets.partial_success"` - `"sheets.pending"` - `"sheets.success"` - `"split.cancelled"` - `"split.error"` - `"split.pending"` - `"split.processing"` - `"split.success"` - `"unmapped_event"` - `webhook_headers?: Record | null` Custom HTTP headers sent with each webhook request (e.g. auth tokens) - `webhook_output_format?: string | null` Response format sent to the webhook: 'string' (default) or 'json' - `webhook_signing_secret?: string | null` 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. - `webhook_url?: string | null` URL to receive webhook POST notifications - `regions?: Array` 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` 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 ### Example ```typescript import LlamaCloud from '@llamaindex/llama-cloud'; const client = new LlamaCloud({ apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const sheetsJob of client.sheets.list()) { console.log(sheetsJob.id); } ``` #### Response ```json { "items": [ { "id": "id", "configuration": { "extraction_range": "extraction_range", "flatten_hierarchical_tables": true, "generate_additional_metadata": true, "include_hidden_cells": true, "sheet_names": [ "string" ], "specialization": "specialization", "table_merge_sensitivity": "strong", "tier": "agentic", "use_experimental_processing": true }, "created_at": "created_at", "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "CANCELLED", "updated_at": "updated_at", "user_id": "user_id", "config": { "extraction_range": "extraction_range", "flatten_hierarchical_tables": true, "generate_additional_metadata": true, "include_hidden_cells": true, "sheet_names": [ "string" ], "specialization": "specialization", "table_merge_sensitivity": "strong", "tier": "agentic", "use_experimental_processing": true }, "configuration_id": "configuration_id", "errors": [ "string" ], "file": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "name": "x", "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "expires_at": "2019-12-27T18:11:19.117Z", "external_file_id": "external_file_id", "file_size": 0, "file_type": "x", "last_modified_at": "2019-12-27T18:11:19.117Z", "permission_info": { "foo": { "foo": "bar" } }, "purpose": "purpose", "resource_info": { "foo": { "foo": "bar" } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "metadata_state_transitions": { "foo": "bar" }, "parameters": { "webhook_configurations": [ { "webhook_events": [ "parse.success", "parse.error" ], "webhook_headers": { "Authorization": "Bearer sk-..." }, "webhook_output_format": "json", "webhook_signing_secret": "whsec_...", "webhook_url": "https://example.com/webhooks/llamacloud" } ] }, "regions": [ { "location": "location", "region_type": "region_type", "sheet_name": "sheet_name", "description": "description", "region_id": "region_id", "title": "title" } ], "success": true, "worksheet_metadata": [ { "sheet_name": "sheet_name", "description": "description", "title": "title" } ] } ], "next_page_token": "next_page_token", "total_size": 0 } ``` ## Get Spreadsheet Job `client.sheets.get(stringspreadsheetJobID, SheetGetParamsquery?, RequestOptionsoptions?): SheetsJob` **get** `/api/v1/sheets/jobs/{spreadsheet_job_id}` Get a spreadsheet parsing job. When `include_results=True` (default), embeds extracted regions and results if complete, skipping the separate `/results` call. ### Parameters - `spreadsheetJobID: string` - `query: SheetGetParams` - `expand?: Array` Optional fields to populate on the response. Valid values: metadata_state_transitions. - `include_results?: boolean` - `organization_id?: string | null` - `project_id?: string | null` ### Returns - `SheetsJob` A spreadsheet parsing job. - `id: string` The ID of the job - `configuration: SheetsParsingConfig` Configuration applied to the parsing job (inline or resolved from a saved preset). - `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` Deprecated: controlled by `tier`. Whether to generate additional metadata (title, description) for each extracted region. Honored only on `agentic`. - `include_hidden_cells?: boolean` Whether to include hidden cells when extracting regions from the spreadsheet. - `sheet_names?: Array | null` The names of the sheets to extract regions from. If empty, all sheets will be processed. - `specialization?: string | null` Deprecated: controlled by `tier`. Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. Honored only on `agentic`. - `table_merge_sensitivity?: "strong" | "weak"` Deprecated: controlled by `tier`. Influences how likely similar-looking regions are merged into a single table. Honored only on `agentic`. - `"strong"` - `"weak"` - `tier?: "agentic" | "cost_effective"` Spreadsheet extraction tier. `cost_effective` uses the rule-based/ML-only pipeline; `agentic` uses the full pipeline. - `"agentic"` - `"cost_effective"` - `use_experimental_processing?: boolean` Deprecated: controlled by `tier`. Enables experimental processing. Honored only on `agentic`. - `created_at: string` When the job was created - `file_id: string | null` The ID of the input file - `project_id: string` The ID of the project - `status: "CANCELLED" | "ERROR" | "PARTIAL_SUCCESS" | 2 more` The status of the parsing job - `"CANCELLED"` - `"ERROR"` - `"PARTIAL_SUCCESS"` - `"PENDING"` - `"SUCCESS"` - `updated_at: string` When the job was last updated - `user_id: string` The ID of the user - `config?: SheetsParsingConfig | null` Configuration for spreadsheet parsing and region extraction - `configuration_id?: string | null` The saved product configuration ID used at create time, if any. - `errors?: Array` Any errors encountered - `file?: File | null` Schema for a file. - `id: string` Unique identifier - `name: string` - `project_id: string` The ID of the project that the file belongs to - `created_at?: string | null` Creation datetime - `data_source_id?: string | null` The ID of the data source that the file belongs to - `expires_at?: string | null` The expiration date for the file. Files past this date can be deleted. - `external_file_id?: string | null` The ID of the file in the external system - `file_size?: number | null` Size of the file in bytes - `file_type?: string | null` File type (e.g. pdf, docx, etc.) - `last_modified_at?: string | null` The last modified time of the file - `permission_info?: Record | Array | string | 2 more | null> | null` Permission information for the file - `Record` - `Array` - `string` - `number` - `boolean` - `purpose?: string | null` The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify') - `resource_info?: Record | Array | string | 2 more | null> | null` Resource information for the file - `Record` - `Array` - `string` - `number` - `boolean` - `updated_at?: string | null` Update datetime - `metadata_state_transitions?: Record | null` Per-status entry timestamps. Returned only when requested via `?expand=metadata_state_transitions`. - `parameters?: Parameters` Job-time parameters such as webhook configurations. - `webhook_configurations?: Array | null` Webhook configurations for job status notifications. - `webhook_events?: Array<"classify.cancelled" | "classify.error" | "classify.partial_success" | 25 more> | null` Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered. - `"classify.cancelled"` - `"classify.error"` - `"classify.partial_success"` - `"classify.pending"` - `"classify.running"` - `"classify.success"` - `"extract.cancelled"` - `"extract.error"` - `"extract.partial_success"` - `"extract.pending"` - `"extract.success"` - `"parse.cancelled"` - `"parse.error"` - `"parse.partial_success"` - `"parse.pending"` - `"parse.running"` - `"parse.success"` - `"sheets.cancelled"` - `"sheets.error"` - `"sheets.partial_success"` - `"sheets.pending"` - `"sheets.success"` - `"split.cancelled"` - `"split.error"` - `"split.pending"` - `"split.processing"` - `"split.success"` - `"unmapped_event"` - `webhook_headers?: Record | null` Custom HTTP headers sent with each webhook request (e.g. auth tokens) - `webhook_output_format?: string | null` Response format sent to the webhook: 'string' (default) or 'json' - `webhook_signing_secret?: string | null` 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. - `webhook_url?: string | null` URL to receive webhook POST notifications - `regions?: Array` 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` 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 ### Example ```typescript import LlamaCloud from '@llamaindex/llama-cloud'; const client = new LlamaCloud({ apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted }); const sheetsJob = await client.sheets.get('spreadsheet_job_id'); console.log(sheetsJob.id); ``` #### Response ```json { "id": "id", "configuration": { "extraction_range": "extraction_range", "flatten_hierarchical_tables": true, "generate_additional_metadata": true, "include_hidden_cells": true, "sheet_names": [ "string" ], "specialization": "specialization", "table_merge_sensitivity": "strong", "tier": "agentic", "use_experimental_processing": true }, "created_at": "created_at", "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "CANCELLED", "updated_at": "updated_at", "user_id": "user_id", "config": { "extraction_range": "extraction_range", "flatten_hierarchical_tables": true, "generate_additional_metadata": true, "include_hidden_cells": true, "sheet_names": [ "string" ], "specialization": "specialization", "table_merge_sensitivity": "strong", "tier": "agentic", "use_experimental_processing": true }, "configuration_id": "configuration_id", "errors": [ "string" ], "file": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "name": "x", "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "expires_at": "2019-12-27T18:11:19.117Z", "external_file_id": "external_file_id", "file_size": 0, "file_type": "x", "last_modified_at": "2019-12-27T18:11:19.117Z", "permission_info": { "foo": { "foo": "bar" } }, "purpose": "purpose", "resource_info": { "foo": { "foo": "bar" } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "metadata_state_transitions": { "foo": "bar" }, "parameters": { "webhook_configurations": [ { "webhook_events": [ "parse.success", "parse.error" ], "webhook_headers": { "Authorization": "Bearer sk-..." }, "webhook_output_format": "json", "webhook_signing_secret": "whsec_...", "webhook_url": "https://example.com/webhooks/llamacloud" } ] }, "regions": [ { "location": "location", "region_type": "region_type", "sheet_name": "sheet_name", "description": "description", "region_id": "region_id", "title": "title" } ], "success": true, "worksheet_metadata": [ { "sheet_name": "sheet_name", "description": "description", "title": "title" } ] } ``` ## Get Result Region `client.sheets.getResultTable("cell_metadata" | "extra" | "table"regionType, SheetGetResultTableParamsparams, RequestOptionsoptions?): PresignedURL` **get** `/api/v1/sheets/jobs/{spreadsheet_job_id}/regions/{region_id}/result/{region_type}` Generate a presigned URL to download a specific extracted region. ### Parameters - `regionType: "cell_metadata" | "extra" | "table"` - `"cell_metadata"` - `"extra"` - `"table"` - `params: SheetGetResultTableParams` - `spreadsheet_job_id: string` Path param - `region_id: string` Path param - `expires_at_seconds?: number | null` Query param - `organization_id?: string | null` Query param - `project_id?: string | null` Query param ### Returns - `PresignedURL` Schema for a presigned URL. - `expires_at: string` The time at which the presigned URL expires - `url: string` A presigned URL for IO operations against a private file - `form_fields?: Record | null` Form fields for a presigned POST request ### Example ```typescript import LlamaCloud from '@llamaindex/llama-cloud'; const client = new LlamaCloud({ apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted }); const presignedURL = await client.sheets.getResultTable('cell_metadata', { spreadsheet_job_id: 'spreadsheet_job_id', region_id: 'region_id', }); console.log(presignedURL.expires_at); ``` #### Response ```json { "expires_at": "2019-12-27T18:11:19.117Z", "url": "https://example.com", "form_fields": { "foo": "string" } } ``` ## Delete Spreadsheet Job `client.sheets.deleteJob(stringspreadsheetJobID, SheetDeleteJobParamsparams?, RequestOptionsoptions?): SheetDeleteJobResponse` **delete** `/api/v1/sheets/jobs/{spreadsheet_job_id}` Delete a spreadsheet parsing job and its associated data. ### Parameters - `spreadsheetJobID: string` - `params: SheetDeleteJobParams` - `organization_id?: string | null` - `project_id?: string | null` ### Returns - `SheetDeleteJobResponse = unknown` ### Example ```typescript import LlamaCloud from '@llamaindex/llama-cloud'; const client = new LlamaCloud({ apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted }); const response = await client.sheets.deleteJob('spreadsheet_job_id'); console.log(response); ``` #### Response ```json {} ``` ## Domain Types ### Sheet Delete Job Response - `SheetDeleteJobResponse = unknown`