Extract
List Extract Jobs
Get Extract Job
Delete Extract Job
Validate Extraction Schema
Generate Extraction Schema
ModelsExpand Collapse
type ExtractConfiguration struct{…}
Extract configuration combining parse and extract settings.
ExtractionTarget ExtractConfigurationExtractionTargetoptional
Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row
ParseConfigID stringoptional
Saved parse configuration ID to control how the document is parsed before extraction
ParseTier stringoptional
Parse tier to use before extraction. Defaults to the extract tier if not specified.
TargetPages stringoptional
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
Version stringoptional
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.
type ExtractJobMetadata struct{…}
Extraction metadata.
Metadata for extracted fields including document, page, and row level info.
DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]optional
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.
type ExtractV2Job struct{…}
An extraction job.
Status string
Current job status.
PENDING— queued, not yet startedRUNNING— actively processingCOMPLETED— finished successfullyFAILED— terminated with an errorCANCELLED— cancelled by user
Extract configuration combining parse and extract settings.
ExtractionTarget ExtractConfigurationExtractionTargetoptional
Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row
ParseConfigID stringoptional
Saved parse configuration ID to control how the document is parsed before extraction
ParseTier stringoptional
Parse tier to use before extraction. Defaults to the extract tier if not specified.
TargetPages stringoptional
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
Version stringoptional
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.
Extraction metadata.
Metadata for extracted fields including document, page, and row level info.
DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]optional
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 ExtractV2JobExtractResultUnionoptional
type ExtractV2JobCreate struct{…}
Request to create an extraction job. Provide configuration_id or inline configuration.
Extract configuration combining parse and extract settings.
ExtractionTarget ExtractConfigurationExtractionTargetoptional
Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row
ParseConfigID stringoptional
Saved parse configuration ID to control how the document is parsed before extraction
ParseTier stringoptional
Parse tier to use before extraction. Defaults to the extract tier if not specified.
TargetPages stringoptional
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
Version stringoptional
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.
WebhookConfigurations []ExtractV2JobCreateWebhookConfigurationoptional
Outbound webhook endpoints to notify on job status changes
WebhookEvents []stringoptional
Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.
WebhookHeaders map[string, string]optional
Custom HTTP headers sent with each webhook request (e.g. auth tokens)
WebhookSigningSecret stringoptional
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=
type ExtractV2JobQueryResponse struct{…}
Paginated list of extraction jobs.
Items []ExtractV2Job
The list of items.
Status string
Current job status.
PENDING— queued, not yet startedRUNNING— actively processingCOMPLETED— finished successfullyFAILED— terminated with an errorCANCELLED— cancelled by user
Extract configuration combining parse and extract settings.
ExtractionTarget ExtractConfigurationExtractionTargetoptional
Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row
ParseConfigID stringoptional
Saved parse configuration ID to control how the document is parsed before extraction
ParseTier stringoptional
Parse tier to use before extraction. Defaults to the extract tier if not specified.
TargetPages stringoptional
Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
Version stringoptional
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.
Extraction metadata.
Metadata for extracted fields including document, page, and row level info.
DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]optional
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 ExtractV2JobExtractResultUnionoptional
type ExtractedFieldMetadata struct{…}
Metadata for extracted fields including document, page, and row level info.
DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]optional
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.