Extract
Create Extract Job
List Extract Jobs
Get Extract Job
Delete Extract Job
Cancel Extract Job
Validate Extraction Schema
Generate Extraction Schema
ModelsExpand Collapse
class ExtractConfiguration:
Extract configuration combining parse and extract settings.
Boolean CiteSources
Include citations in results. Returned under extract_metadata (auto-included when set). Text-level on turbo (no bounding boxes).
Boolean ConfidenceScores
Include confidence scores in results. Returned under extract_metadata (auto-included when set).
string? ParseConfigID
Saved parse configuration ID to control how the document is parsed before extraction. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.
ParseTier? ParseTier
Parse tier to use before extraction. Defaults to the extract tier if not specified. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.
IReadOnlyList<string>? SheetNames
Optional worksheet names to extract when spreadsheet_mode is on. Overrides target_pages for spreadsheets; omit to extract every sheet. Names are matched exactly (case-sensitive) — pass them as a list, e.g. [“Sheet 1”, “My Sheet”].
Boolean SpreadsheetMode
Beta. When true, extract structured data directly from a spreadsheet workbook (.xlsx/.xls/.csv) — the agent reads cells straight from the workbook instead of the standard document path. Off by default (spreadsheets keep the standard path). Requires the agentic_plus tier. Billed on the standard per-page extract rate, against a page count derived from workbook size. Citations and confidence scores are not available in this mode.
string? TargetPages
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
string Version
Use ‘latest’ for the latest release for the selected tier or a date string (YYYY-MM-DD format) to pin to the nearest release at or before that date. Job responses always report the concrete resolved version the job runs, fixed at job creation; saved configurations keep the value as provided.
class ExtractJobMetadata:
Extraction metadata.
ExtractedFieldMetadata? FieldMetadata
Metadata for extracted fields including document, page, and row level info.
IReadOnlyDictionary<string, DocumentMetadata?>? DocumentMetadata
Per-field metadata keyed by field name from your schema. Scalar fields (e.g. vendor) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. items) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively.
class ExtractV2Job:
An extraction job.
required string Status
Current job status.
PENDING— queued, not yet startedRUNNING— actively processingCOMPLETED— finished successfullyFAILED— terminated with an errorCANCELLED— cancelled by user
ExtractConfiguration? Configuration
Extract configuration combining parse and extract settings.
Boolean CiteSources
Include citations in results. Returned under extract_metadata (auto-included when set). Text-level on turbo (no bounding boxes).
Boolean ConfidenceScores
Include confidence scores in results. Returned under extract_metadata (auto-included when set).
string? ParseConfigID
Saved parse configuration ID to control how the document is parsed before extraction. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.
ParseTier? ParseTier
Parse tier to use before extraction. Defaults to the extract tier if not specified. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.
IReadOnlyList<string>? SheetNames
Optional worksheet names to extract when spreadsheet_mode is on. Overrides target_pages for spreadsheets; omit to extract every sheet. Names are matched exactly (case-sensitive) — pass them as a list, e.g. [“Sheet 1”, “My Sheet”].
Boolean SpreadsheetMode
Beta. When true, extract structured data directly from a spreadsheet workbook (.xlsx/.xls/.csv) — the agent reads cells straight from the workbook instead of the standard document path. Off by default (spreadsheets keep the standard path). Requires the agentic_plus tier. Billed on the standard per-page extract rate, against a page count derived from workbook size. Citations and confidence scores are not available in this mode.
string? TargetPages
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
string Version
Use ‘latest’ for the latest release for the selected tier or a date string (YYYY-MM-DD format) to pin to the nearest release at or before that date. Job responses always report the concrete resolved version the job runs, fixed at job creation; saved configurations keep the value as provided.
ExtractJobMetadata? ExtractMetadata
Extraction metadata.
ExtractedFieldMetadata? FieldMetadata
Metadata for extracted fields including document, page, and row level info.
IReadOnlyDictionary<string, DocumentMetadata?>? DocumentMetadata
Per-field metadata keyed by field name from your schema. Scalar fields (e.g. vendor) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. items) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively.
ExtractResult? ExtractResult
Metadata? Metadata
Job-level metadata.
ExtractJobUsage? Usage
class ExtractV2JobCreate:
Request to create an extraction job. Provide configuration_id or inline configuration.
ExtractConfiguration? Configuration
Extract configuration combining parse and extract settings.
Boolean CiteSources
Include citations in results. Returned under extract_metadata (auto-included when set). Text-level on turbo (no bounding boxes).
Boolean ConfidenceScores
Include confidence scores in results. Returned under extract_metadata (auto-included when set).
string? ParseConfigID
Saved parse configuration ID to control how the document is parsed before extraction. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.
ParseTier? ParseTier
Parse tier to use before extraction. Defaults to the extract tier if not specified. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.
IReadOnlyList<string>? SheetNames
Optional worksheet names to extract when spreadsheet_mode is on. Overrides target_pages for spreadsheets; omit to extract every sheet. Names are matched exactly (case-sensitive) — pass them as a list, e.g. [“Sheet 1”, “My Sheet”].
Boolean SpreadsheetMode
Beta. When true, extract structured data directly from a spreadsheet workbook (.xlsx/.xls/.csv) — the agent reads cells straight from the workbook instead of the standard document path. Off by default (spreadsheets keep the standard path). Requires the agentic_plus tier. Billed on the standard per-page extract rate, against a page count derived from workbook size. Citations and confidence scores are not available in this mode.
string? TargetPages
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
string Version
Use ‘latest’ for the latest release for the selected tier or a date string (YYYY-MM-DD format) to pin to the nearest release at or before that date. Job responses always report the concrete resolved version the job runs, fixed at job creation; saved configurations keep the value as provided.
IReadOnlyList<string>? WebhookConfigurationIds
IDs of saved webhook configurations to notify for this job.
IReadOnlyList<WebhookConfiguration>? WebhookConfigurations
Outbound webhook endpoints to notify on job status changes
IReadOnlyList<WebhookEvent>? WebhookEvents
Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.
IReadOnlyDictionary<string, string>? WebhookHeaders
Custom HTTP headers sent with each webhook request (e.g. auth tokens)
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=
class ExtractV2JobQueryResponse:
Paginated list of extraction jobs.
The list of items.
required string Status
Current job status.
PENDING— queued, not yet startedRUNNING— actively processingCOMPLETED— finished successfullyFAILED— terminated with an errorCANCELLED— cancelled by user
ExtractConfiguration? Configuration
Extract configuration combining parse and extract settings.
Boolean CiteSources
Include citations in results. Returned under extract_metadata (auto-included when set). Text-level on turbo (no bounding boxes).
Boolean ConfidenceScores
Include confidence scores in results. Returned under extract_metadata (auto-included when set).
string? ParseConfigID
Saved parse configuration ID to control how the document is parsed before extraction. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.
ParseTier? ParseTier
Parse tier to use before extraction. Defaults to the extract tier if not specified. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.
IReadOnlyList<string>? SheetNames
Optional worksheet names to extract when spreadsheet_mode is on. Overrides target_pages for spreadsheets; omit to extract every sheet. Names are matched exactly (case-sensitive) — pass them as a list, e.g. [“Sheet 1”, “My Sheet”].
Boolean SpreadsheetMode
Beta. When true, extract structured data directly from a spreadsheet workbook (.xlsx/.xls/.csv) — the agent reads cells straight from the workbook instead of the standard document path. Off by default (spreadsheets keep the standard path). Requires the agentic_plus tier. Billed on the standard per-page extract rate, against a page count derived from workbook size. Citations and confidence scores are not available in this mode.
string? TargetPages
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
string Version
Use ‘latest’ for the latest release for the selected tier or a date string (YYYY-MM-DD format) to pin to the nearest release at or before that date. Job responses always report the concrete resolved version the job runs, fixed at job creation; saved configurations keep the value as provided.
ExtractJobMetadata? ExtractMetadata
Extraction metadata.
ExtractedFieldMetadata? FieldMetadata
Metadata for extracted fields including document, page, and row level info.
IReadOnlyDictionary<string, DocumentMetadata?>? DocumentMetadata
Per-field metadata keyed by field name from your schema. Scalar fields (e.g. vendor) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. items) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively.
ExtractResult? ExtractResult
Metadata? Metadata
Job-level metadata.
ExtractJobUsage? Usage
class ExtractedFieldMetadata:
Metadata for extracted fields including document, page, and row level info.
IReadOnlyDictionary<string, DocumentMetadata?>? DocumentMetadata
Per-field metadata keyed by field name from your schema. Scalar fields (e.g. vendor) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. items) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively.