Extract
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.
cite_sources: Optional[bool]
Include citations in results. Returned under extract_metadata (auto-included when set). Text-level on turbo (no bounding boxes).
confidence_scores: Optional[bool]
Include confidence scores in results. Returned under extract_metadata (auto-included when set).
parse_config_id: Optional[str]
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.
sheet_names: Optional[List[str]]
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”].
spreadsheet_mode: Optional[bool]
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.
target_pages: Optional[str]
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
version: Optional[str]
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.
field_metadata: Optional[ExtractedFieldMetadata]
Metadata for extracted fields including document, page, and row level info.
document_metadata: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]
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.
status: str
Current job status.
PENDING— queued, not yet startedRUNNING— actively processingCOMPLETED— finished successfullyFAILED— terminated with an errorCANCELLED— cancelled by user
configuration: Optional[ExtractConfiguration]
Extract configuration combining parse and extract settings.
cite_sources: Optional[bool]
Include citations in results. Returned under extract_metadata (auto-included when set). Text-level on turbo (no bounding boxes).
confidence_scores: Optional[bool]
Include confidence scores in results. Returned under extract_metadata (auto-included when set).
parse_config_id: Optional[str]
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.
sheet_names: Optional[List[str]]
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”].
spreadsheet_mode: Optional[bool]
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.
target_pages: Optional[str]
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
version: Optional[str]
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.
extract_metadata: Optional[ExtractJobMetadata]
Extraction metadata.
field_metadata: Optional[ExtractedFieldMetadata]
Metadata for extracted fields including document, page, and row level info.
document_metadata: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]
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.
extract_result: Optional[Union[Dict[str, Union[Dict[str, object], List[object], str, 3 more]], List[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]], null]]
Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row.
class ExtractV2JobCreate: …
Request to create an extraction job. Provide configuration_id or inline configuration.
configuration: Optional[ExtractConfiguration]
Extract configuration combining parse and extract settings.
cite_sources: Optional[bool]
Include citations in results. Returned under extract_metadata (auto-included when set). Text-level on turbo (no bounding boxes).
confidence_scores: Optional[bool]
Include confidence scores in results. Returned under extract_metadata (auto-included when set).
parse_config_id: Optional[str]
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.
sheet_names: Optional[List[str]]
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”].
spreadsheet_mode: Optional[bool]
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.
target_pages: Optional[str]
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
version: Optional[str]
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.
webhook_configuration_ids: Optional[List[str]]
IDs of saved webhook configurations to notify for this job.
webhook_configurations: Optional[List[WebhookConfiguration]]
Outbound webhook endpoints to notify on job status changes
webhook_events: Optional[List[Literal["batch.cancelled", "batch.error", "batch.pending", 30 more]]]
Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.
webhook_headers: Optional[Dict[str, str]]
Custom HTTP headers sent with each webhook request (e.g. auth tokens)
webhook_output_format: Optional[str]
Response format sent to the webhook: ‘string’ (default) or ‘json’
webhook_signing_secret: Optional[str]
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.
status: str
Current job status.
PENDING— queued, not yet startedRUNNING— actively processingCOMPLETED— finished successfullyFAILED— terminated with an errorCANCELLED— cancelled by user
configuration: Optional[ExtractConfiguration]
Extract configuration combining parse and extract settings.
cite_sources: Optional[bool]
Include citations in results. Returned under extract_metadata (auto-included when set). Text-level on turbo (no bounding boxes).
confidence_scores: Optional[bool]
Include confidence scores in results. Returned under extract_metadata (auto-included when set).
parse_config_id: Optional[str]
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.
sheet_names: Optional[List[str]]
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”].
spreadsheet_mode: Optional[bool]
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.
target_pages: Optional[str]
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
version: Optional[str]
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.
extract_metadata: Optional[ExtractJobMetadata]
Extraction metadata.
field_metadata: Optional[ExtractedFieldMetadata]
Metadata for extracted fields including document, page, and row level info.
document_metadata: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]
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.
extract_result: Optional[Union[Dict[str, Union[Dict[str, object], List[object], str, 3 more]], List[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]], null]]
Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row.
class ExtractedFieldMetadata: …
Metadata for extracted fields including document, page, and row level info.
document_metadata: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]
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.