Skip to content
LlamaIndex API Docs
Framework Docs
API Reference

Extract

Create Extract Job
$ llamacloud-prod extract create
POST/api/v2/extract
List Extract Jobs
$ llamacloud-prod extract list
GET/api/v2/extract
Get Extract Job
$ llamacloud-prod extract get
GET/api/v2/extract/{job_id}
Delete Extract Job
$ llamacloud-prod extract delete
DELETE/api/v2/extract/{job_id}
Validate Extraction Schema
$ llamacloud-prod extract validate-schema
POST/api/v2/extract/schema/validation
Generate Extraction Schema
$ llamacloud-prod extract generate-schema
POST/api/v2/extract/schema/generate
ModelsExpand Collapse
extract_configuration: object { data_schema, cite_sources, confidence_scores, 8 more }

Extract configuration combining parse and extract settings.

data_schema: map[map[unknown] or array of unknown or string or 2 more]

JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first.

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
cite_sources: optional boolean

Include citations in results

confidence_scores: optional boolean

Include confidence scores in results

extract_version: optional string

Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release.

extraction_target: optional "per_doc" or "per_page" or "per_table_row"

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

"per_doc"
"per_page"
"per_table_row"
max_pages: optional number

Maximum number of pages to process. Omit for no limit.

parse_config_id: optional string

Saved parse configuration ID to control how the document is parsed before extraction

parse_tier: optional string

Parse tier to use before extraction. Defaults to the extract tier if not specified.

system_prompt: optional string

Custom system prompt to guide extraction behavior

target_pages: optional string

Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.

tier: optional "cost_effective" or "agentic"

Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page)

"cost_effective"
"agentic"
extract_job_metadata: object { field_metadata, parse_job_id, parse_tier }

Extraction metadata.

field_metadata: optional object { document_metadata, page_metadata, row_metadata }

Metadata for extracted fields including document, page, and row level info.

document_metadata: optional map[map[unknown] or array of unknown or string or 2 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.

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
page_metadata: optional array of map[map[unknown] or array of unknown or string or 2 more]

Per-page metadata when extraction_target is per_page

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
row_metadata: optional array of map[map[unknown] or array of unknown or string or 2 more]

Per-row metadata when extraction_target is per_table_row

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
parse_job_id: optional string

Reference to the ParseJob ID used for parsing

parse_tier: optional string

Parse tier used for parsing the document

extract_job_usage: object { num_document_tokens, num_output_tokens, num_pages_extracted }

Extraction usage metrics.

num_document_tokens: optional number

Number of document tokens

num_output_tokens: optional number

Number of output tokens

num_pages_extracted: optional number

Number of pages extracted

extract_v2_job: object { id, created_at, file_input, 9 more }

An extraction job.

id: string

Unique job identifier (job_id)

created_at: string

Creation timestamp

file_input: string

File ID or parse job ID that was extracted

project_id: string

Project this job belongs to

status: string

Current job status.

  • PENDING — queued, not yet started
  • RUNNING — actively processing
  • COMPLETED — finished successfully
  • FAILED — terminated with an error
  • CANCELLED — cancelled by user
updated_at: string

Last update timestamp

configuration: optional object { data_schema, cite_sources, confidence_scores, 8 more }

Extract configuration combining parse and extract settings.

data_schema: map[map[unknown] or array of unknown or string or 2 more]

JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first.

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
cite_sources: optional boolean

Include citations in results

confidence_scores: optional boolean

Include confidence scores in results

extract_version: optional string

Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release.

extraction_target: optional "per_doc" or "per_page" or "per_table_row"

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

"per_doc"
"per_page"
"per_table_row"
max_pages: optional number

Maximum number of pages to process. Omit for no limit.

parse_config_id: optional string

Saved parse configuration ID to control how the document is parsed before extraction

parse_tier: optional string

Parse tier to use before extraction. Defaults to the extract tier if not specified.

system_prompt: optional string

Custom system prompt to guide extraction behavior

target_pages: optional string

Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.

tier: optional "cost_effective" or "agentic"

Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page)

"cost_effective"
"agentic"
configuration_id: optional string

Saved extract configuration ID used for this job, if any

error_message: optional string

Error details when status is FAILED

extract_metadata: optional object { field_metadata, parse_job_id, parse_tier }

Extraction metadata.

field_metadata: optional object { document_metadata, page_metadata, row_metadata }

Metadata for extracted fields including document, page, and row level info.

document_metadata: optional map[map[unknown] or array of unknown or string or 2 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.

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
page_metadata: optional array of map[map[unknown] or array of unknown or string or 2 more]

Per-page metadata when extraction_target is per_page

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
row_metadata: optional array of map[map[unknown] or array of unknown or string or 2 more]

Per-row metadata when extraction_target is per_table_row

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
parse_job_id: optional string

Reference to the ParseJob ID used for parsing

parse_tier: optional string

Parse tier used for parsing the document

extract_result: optional map[map[unknown] or array of unknown or string or 2 more] or array of map[map[unknown] or array of unknown or string or 2 more]

Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row.

union_member_0: map[map[unknown] or array of unknown or string or 2 more]
union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
union_member_1: array of map[map[unknown] or array of unknown or string or 2 more]
union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
metadata: optional object { usage }

Job-level metadata.

usage: optional object { num_document_tokens, num_output_tokens, num_pages_extracted }

Extraction usage metrics.

num_document_tokens: optional number

Number of document tokens

num_output_tokens: optional number

Number of output tokens

num_pages_extracted: optional number

Number of pages extracted

extract_v2_job_create: object { file_input, configuration, configuration_id, webhook_configurations }

Request to create an extraction job. Provide configuration_id or inline configuration.

file_input: string

File ID or parse job ID to extract from

configuration: optional object { data_schema, cite_sources, confidence_scores, 8 more }

Extract configuration combining parse and extract settings.

data_schema: map[map[unknown] or array of unknown or string or 2 more]

JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first.

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
cite_sources: optional boolean

Include citations in results

confidence_scores: optional boolean

Include confidence scores in results

extract_version: optional string

Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release.

extraction_target: optional "per_doc" or "per_page" or "per_table_row"

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

"per_doc"
"per_page"
"per_table_row"
max_pages: optional number

Maximum number of pages to process. Omit for no limit.

parse_config_id: optional string

Saved parse configuration ID to control how the document is parsed before extraction

parse_tier: optional string

Parse tier to use before extraction. Defaults to the extract tier if not specified.

system_prompt: optional string

Custom system prompt to guide extraction behavior

target_pages: optional string

Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.

tier: optional "cost_effective" or "agentic"

Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page)

"cost_effective"
"agentic"
configuration_id: optional string

Saved configuration ID

webhook_configurations: optional array of object { webhook_events, webhook_headers, webhook_output_format, webhook_url }

Outbound webhook endpoints to notify on job status changes

webhook_events: optional array of "extract.pending" or "extract.success" or "extract.error" or 14 more

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

"extract.pending"
"extract.success"
"extract.error"
"extract.partial_success"
"extract.cancelled"
"parse.pending"
"parse.running"
"parse.success"
"parse.error"
"parse.partial_success"
"parse.cancelled"
"classify.pending"
"classify.success"
"classify.error"
"classify.partial_success"
"classify.cancelled"
"unmapped_event"
webhook_headers: optional map[string]

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

webhook_output_format: optional string

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

webhook_url: optional string

URL to receive webhook POST notifications

extract_v2_job_query_response: object { items, next_page_token, total_size }

Paginated list of extraction jobs.

items: array of ExtractV2Job { id, created_at, file_input, 9 more }

The list of items.

id: string

Unique job identifier (job_id)

created_at: string

Creation timestamp

file_input: string

File ID or parse job ID that was extracted

project_id: string

Project this job belongs to

status: string

Current job status.

  • PENDING — queued, not yet started
  • RUNNING — actively processing
  • COMPLETED — finished successfully
  • FAILED — terminated with an error
  • CANCELLED — cancelled by user
updated_at: string

Last update timestamp

configuration: optional object { data_schema, cite_sources, confidence_scores, 8 more }

Extract configuration combining parse and extract settings.

data_schema: map[map[unknown] or array of unknown or string or 2 more]

JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first.

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
cite_sources: optional boolean

Include citations in results

confidence_scores: optional boolean

Include confidence scores in results

extract_version: optional string

Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release.

extraction_target: optional "per_doc" or "per_page" or "per_table_row"

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

"per_doc"
"per_page"
"per_table_row"
max_pages: optional number

Maximum number of pages to process. Omit for no limit.

parse_config_id: optional string

Saved parse configuration ID to control how the document is parsed before extraction

parse_tier: optional string

Parse tier to use before extraction. Defaults to the extract tier if not specified.

system_prompt: optional string

Custom system prompt to guide extraction behavior

target_pages: optional string

Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.

tier: optional "cost_effective" or "agentic"

Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page)

"cost_effective"
"agentic"
configuration_id: optional string

Saved extract configuration ID used for this job, if any

error_message: optional string

Error details when status is FAILED

extract_metadata: optional object { field_metadata, parse_job_id, parse_tier }

Extraction metadata.

field_metadata: optional object { document_metadata, page_metadata, row_metadata }

Metadata for extracted fields including document, page, and row level info.

document_metadata: optional map[map[unknown] or array of unknown or string or 2 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.

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
page_metadata: optional array of map[map[unknown] or array of unknown or string or 2 more]

Per-page metadata when extraction_target is per_page

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
row_metadata: optional array of map[map[unknown] or array of unknown or string or 2 more]

Per-row metadata when extraction_target is per_table_row

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
parse_job_id: optional string

Reference to the ParseJob ID used for parsing

parse_tier: optional string

Parse tier used for parsing the document

extract_result: optional map[map[unknown] or array of unknown or string or 2 more] or array of map[map[unknown] or array of unknown or string or 2 more]

Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row.

union_member_0: map[map[unknown] or array of unknown or string or 2 more]
union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
union_member_1: array of map[map[unknown] or array of unknown or string or 2 more]
union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
metadata: optional object { usage }

Job-level metadata.

usage: optional object { num_document_tokens, num_output_tokens, num_pages_extracted }

Extraction usage metrics.

num_document_tokens: optional number

Number of document tokens

num_output_tokens: optional number

Number of output tokens

num_pages_extracted: optional number

Number of pages extracted

next_page_token: optional string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: optional number

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

extract_v2_schema_generate_request: object { data_schema, file_id, name, prompt }

Request schema for generating an extraction schema.

data_schema: optional map[map[unknown] or array of unknown or string or 2 more]

Optional schema to validate, refine, or extend

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
file_id: optional string

Optional file ID to analyze for schema generation

name: optional string

Name for the generated configuration (auto-generated if omitted)

prompt: optional string

Natural language description of the data structure to extract

extract_v2_schema_validate_request: object { data_schema }

Request schema for validating an extraction schema.

data_schema: map[map[unknown] or array of unknown or string or 2 more]

JSON Schema to validate for use with extract jobs

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
extract_v2_schema_validate_response: object { data_schema }

Response schema for schema validation.

data_schema: map[map[unknown] or array of unknown or string or 2 more]

Validated JSON Schema, ready for use in extract jobs

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
extracted_field_metadata: object { document_metadata, page_metadata, row_metadata }

Metadata for extracted fields including document, page, and row level info.

document_metadata: optional map[map[unknown] or array of unknown or string or 2 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.

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
page_metadata: optional array of map[map[unknown] or array of unknown or string or 2 more]

Per-page metadata when extraction_target is per_page

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean
row_metadata: optional array of map[map[unknown] or array of unknown or string or 2 more]

Per-row metadata when extraction_target is per_table_row

union_member_0: map[unknown]
union_member_1: array of unknown
union_member_2: string
union_member_3: number
union_member_4: boolean