# Extract ## Create Extract Job `$ llamacloud-prod extract create` **post** `/api/v2/extract` Create an extraction job. Extracts structured data from a document using either a saved configuration or an inline JSON Schema. ## Input Provide exactly one of: - `configuration_id` — reference a saved extraction config - `configuration` — inline configuration with a `data_schema` ## Document input Set `file_input` to a file ID (`dfl-...`) or a completed parse job ID (`pjb-...`). The job runs asynchronously. Poll `GET /extract/{job_id}` or register a webhook to monitor completion. ### Parameters - `--file-input: string` Body param: File ID or parse job ID to extract from - `--organization-id: optional string` Query param - `--project-id: optional string` Query param - `--configuration: optional object { data_schema, cite_sources, confidence_scores, 8 more }` Body param: Extract configuration combining parse and extract settings. - `--configuration-id: optional string` Body param: Saved configuration ID - `--webhook-configuration: optional array of object { webhook_events, webhook_headers, webhook_output_format, webhook_url }` Body param: Outbound webhook endpoints to notify on job status changes ### Returns - `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 ### Example ```cli llamacloud-prod extract create \ --api-key 'My API Key' \ --file-input dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee ``` #### Response ```json { "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "created_at": "2019-12-27T18:11:19.117Z", "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "status": "COMPLETED", "updated_at": "2019-12-27T18:11:19.117Z", "configuration": { "data_schema": { "foo": { "foo": "bar" } }, "cite_sources": true, "confidence_scores": true, "extract_version": "latest", "extraction_target": "per_doc", "max_pages": 10, "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555", "parse_tier": "fast", "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.", "target_pages": "1,3,5-7", "tier": "cost_effective" }, "configuration_id": "cfg-11111111-2222-3333-4444-555555555555", "error_message": "error_message", "extract_metadata": { "field_metadata": { "document_metadata": { "items": [ { "amount": { "citation": [ { "matching_text": "$10.00", "page": 1 } ], "confidence": 1 }, "description": { "citation": [ { "matching_text": "$10/month", "page": 1 } ], "confidence": 0.998 } } ], "total": { "citation": "bar", "confidence": "bar" }, "vendor": { "citation": "bar", "confidence": "bar", "extraction_confidence": "bar", "parsing_confidence": "bar" } }, "page_metadata": [ { "foo": { "foo": "bar" } } ], "row_metadata": [ { "foo": { "foo": "bar" } } ] }, "parse_job_id": "parse_job_id", "parse_tier": "parse_tier" }, "extract_result": { "foo": { "foo": "bar" } }, "metadata": { "usage": { "num_document_tokens": 0, "num_output_tokens": 0, "num_pages_extracted": 0 } } } ``` ## List Extract Jobs `$ llamacloud-prod extract list` **get** `/api/v2/extract` List extraction jobs with optional filtering and pagination. Filter by `configuration_id`, `status`, `file_input`, or creation date range. Results are returned newest-first. Use `expand=configuration` to include the full configuration used, and `expand=extract_metadata` for per-field metadata. ### Parameters - `--configuration-id: optional string` Filter by configuration ID - `--created-at-on-or-after: optional string` Include items created at or after this timestamp (inclusive) - `--created-at-on-or-before: optional string` Include items created at or before this timestamp (inclusive) - `--document-input-type: optional string` Filter by document input type (file_id or parse_job_id) - `--document-input-value: optional string` Deprecated: use file_input instead - `--expand: optional array of string` Additional fields to include: configuration, extract_metadata - `--file-input: optional string` Filter by file input value - `--job-id: optional array of string` Filter by specific job IDs - `--organization-id: optional string` - `--page-size: optional number` Number of items per page - `--page-token: optional string` Token for pagination - `--project-id: optional string` - `--status: optional "PENDING" or "THROTTLED" or "RUNNING" or 3 more` Filter by status ### Returns - `extract_v2_job_query_response: object { items, next_page_token, total_size }` Paginated list of extraction jobs. - `items: array of ExtractV2Job` 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. ### Example ```cli llamacloud-prod extract list \ --api-key 'My API Key' ``` #### Response ```json { "items": [ { "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "created_at": "2019-12-27T18:11:19.117Z", "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "status": "COMPLETED", "updated_at": "2019-12-27T18:11:19.117Z", "configuration": { "data_schema": { "foo": { "foo": "bar" } }, "cite_sources": true, "confidence_scores": true, "extract_version": "latest", "extraction_target": "per_doc", "max_pages": 10, "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555", "parse_tier": "fast", "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.", "target_pages": "1,3,5-7", "tier": "cost_effective" }, "configuration_id": "cfg-11111111-2222-3333-4444-555555555555", "error_message": "error_message", "extract_metadata": { "field_metadata": { "document_metadata": { "items": [ { "amount": { "citation": [ { "matching_text": "$10.00", "page": 1 } ], "confidence": 1 }, "description": { "citation": [ { "matching_text": "$10/month", "page": 1 } ], "confidence": 0.998 } } ], "total": { "citation": "bar", "confidence": "bar" }, "vendor": { "citation": "bar", "confidence": "bar", "extraction_confidence": "bar", "parsing_confidence": "bar" } }, "page_metadata": [ { "foo": { "foo": "bar" } } ], "row_metadata": [ { "foo": { "foo": "bar" } } ] }, "parse_job_id": "parse_job_id", "parse_tier": "parse_tier" }, "extract_result": { "foo": { "foo": "bar" } }, "metadata": { "usage": { "num_document_tokens": 0, "num_output_tokens": 0, "num_pages_extracted": 0 } } } ], "next_page_token": "next_page_token", "total_size": 0 } ``` ## Get Extract Job `$ llamacloud-prod extract get` **get** `/api/v2/extract/{job_id}` Get a single extraction job by ID. Returns the job status and results when complete. Use `expand=configuration` to include the full configuration used, and `expand=extract_metadata` for per-field metadata. ### Parameters - `--job-id: string` - `--expand: optional array of string` Additional fields to include: configuration, extract_metadata - `--organization-id: optional string` - `--project-id: optional string` ### Returns - `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 ### Example ```cli llamacloud-prod extract get \ --api-key 'My API Key' \ --job-id job_id ``` #### Response ```json { "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "created_at": "2019-12-27T18:11:19.117Z", "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "status": "COMPLETED", "updated_at": "2019-12-27T18:11:19.117Z", "configuration": { "data_schema": { "foo": { "foo": "bar" } }, "cite_sources": true, "confidence_scores": true, "extract_version": "latest", "extraction_target": "per_doc", "max_pages": 10, "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555", "parse_tier": "fast", "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.", "target_pages": "1,3,5-7", "tier": "cost_effective" }, "configuration_id": "cfg-11111111-2222-3333-4444-555555555555", "error_message": "error_message", "extract_metadata": { "field_metadata": { "document_metadata": { "items": [ { "amount": { "citation": [ { "matching_text": "$10.00", "page": 1 } ], "confidence": 1 }, "description": { "citation": [ { "matching_text": "$10/month", "page": 1 } ], "confidence": 0.998 } } ], "total": { "citation": "bar", "confidence": "bar" }, "vendor": { "citation": "bar", "confidence": "bar", "extraction_confidence": "bar", "parsing_confidence": "bar" } }, "page_metadata": [ { "foo": { "foo": "bar" } } ], "row_metadata": [ { "foo": { "foo": "bar" } } ] }, "parse_job_id": "parse_job_id", "parse_tier": "parse_tier" }, "extract_result": { "foo": { "foo": "bar" } }, "metadata": { "usage": { "num_document_tokens": 0, "num_output_tokens": 0, "num_pages_extracted": 0 } } } ``` ## Delete Extract Job `$ llamacloud-prod extract delete` **delete** `/api/v2/extract/{job_id}` Delete an extraction job and its results. ### Parameters - `--job-id: string` - `--organization-id: optional string` - `--project-id: optional string` ### Returns - `ExtractDeleteResponse: unknown` ### Example ```cli llamacloud-prod extract delete \ --api-key 'My API Key' \ --job-id job_id ``` #### Response ```json {} ``` ## Validate Extraction Schema `$ llamacloud-prod extract validate-schema` **post** `/api/v2/extract/schema/validation` Validate a JSON schema for extraction. ### Parameters - `--data-schema: map[map[unknown] or array of unknown or string or 2 more]` JSON Schema to validate for use with extract jobs ### Returns - `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` ### Example ```cli llamacloud-prod extract validate-schema \ --api-key 'My API Key' \ --data-schema '{foo: {foo: bar}}' ``` #### Response ```json { "data_schema": { "foo": { "foo": "bar" } } } ``` ## Generate Extraction Schema `$ llamacloud-prod extract generate-schema` **post** `/api/v2/extract/schema/generate` Generate a JSON schema and return a product configuration request. ### Parameters - `--organization-id: optional string` Query param - `--project-id: optional string` Query param - `--data-schema: optional map[map[unknown] or array of unknown or string or 2 more]` Body param: Optional schema to validate, refine, or extend - `--file-id: optional string` Body param: Optional file ID to analyze for schema generation - `--name: optional string` Body param: Name for the generated configuration (auto-generated if omitted) - `--prompt: optional string` Body param: Natural language description of the data structure to extract ### Returns - `configuration_create: object { name, parameters }` Request body for creating a product configuration. - `name: string` Human-readable name for this configuration. - `parameters: SplitV1Parameters or ExtractV2Parameters or ClassifyV2Parameters or 3 more` Product-specific configuration parameters. - `split_v1_parameters: object { categories, product_type, splitting_strategy }` Typed parameters for a *split v1* product configuration. - `categories: array of SplitCategory` Categories to split documents into. - `name: string` Name of the category. - `description: optional string` Optional description of what content belongs in this category. - `product_type: "split_v1"` Product type. - `"split_v1"` - `splitting_strategy: optional object { allow_uncategorized }` Strategy for splitting documents. - `allow_uncategorized: optional "include" or "forbid" or "omit"` Controls handling of pages that don't match any category. 'include': pages can be grouped as 'uncategorized' and included in results. 'forbid': all pages must be assigned to a defined category. 'omit': pages can be classified as 'uncategorized' but are excluded from results. - `"include"` - `"forbid"` - `"omit"` - `extract_v2_parameters: object { data_schema, product_type, cite_sources, 9 more }` Typed parameters for an *extract v2* product configuration. - `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` - `product_type: "extract_v2"` Product type. - `"extract_v2"` - `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"` - `classify_v2_parameters: object { product_type, rules, mode, parsing_configuration }` Typed parameters for a *classify v2* product configuration. - `product_type: "classify_v2"` Product type. - `"classify_v2"` - `rules: array of object { description, type }` Classify rules to evaluate against the document (at least one required) - `description: string` Natural language criteria for matching this rule - `type: string` Document type to assign when rule matches - `mode: optional "FAST"` Classify execution mode - `"FAST"` - `parsing_configuration: optional object { lang, max_pages, target_pages }` Parsing configuration for classify jobs. - `lang: optional string` ISO 639-1 language code for the document - `max_pages: optional number` Maximum number of pages to process. Omit for no limit. - `target_pages: optional string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `parse_v2_parameters: object { product_type, tier, version, 11 more }` Configuration for LlamaParse v2 document parsing. Includes tier selection, processing options, output formatting, page targeting, and webhook delivery. Refer to the LlamaParse documentation for details on each field. - `product_type: "parse_v2"` Product type. - `"parse_v2"` - `tier: "fast" or "cost_effective" or "agentic" or "agentic_plus"` Parsing tier: 'fast' (rule-based, cheapest), 'cost_effective' (balanced), 'agentic' (AI-powered with custom prompts), or 'agentic_plus' (premium AI with highest accuracy) - `"fast"` - `"cost_effective"` - `"agentic"` - `"agentic_plus"` - `version: "2025-12-11" or "2025-12-18" or "2025-12-31" or 40 more or string` Tier version. Use 'latest' for the current stable version, or specify a specific version (e.g., '1.0', '2.0') for reproducible results - `"2025-12-11"` - `"2025-12-18"` - `"2025-12-31"` - `"2026-01-08"` - `"2026-01-09"` - `"2026-01-16"` - `"2026-01-21"` - `"2026-01-22"` - `"2026-01-24"` - `"2026-01-29"` - `"2026-01-30"` - `"2026-02-03"` - `"2026-02-18"` - `"2026-02-20"` - `"2026-02-24"` - `"2026-02-26"` - `"2026-03-02"` - `"2026-03-03"` - `"2026-03-04"` - `"2026-03-05"` - `"2026-03-09"` - `"2026-03-10"` - `"2026-03-11"` - `"2026-03-12"` - `"2026-03-17"` - `"2026-03-19"` - `"2026-03-20"` - `"2026-03-22"` - `"2026-03-23"` - `"2026-03-24"` - `"2026-03-25"` - `"2026-03-26"` - `"2026-03-27"` - `"2026-03-30"` - `"2026-03-31"` - `"2026-04-02"` - `"2026-04-06"` - `"2026-04-09"` - `"2026-04-14"` - `"2026-04-19"` - `"2026-04-22"` - `"2026-04-27"` - `"latest"` - `agentic_options: optional object { custom_prompt }` Options for AI-powered parsing tiers (cost_effective, agentic, agentic_plus). These options customize how the AI processes and interprets document content. Only applicable when using non-fast tiers. - `custom_prompt: optional string` Custom instructions for the AI parser. Use to guide extraction behavior, specify output formatting, or provide domain-specific context. Example: 'Extract financial tables with currency symbols. Format dates as YYYY-MM-DD.' - `client_name: optional string` Identifier for the client/application making the request. Used for analytics and debugging. Example: 'my-app-v2' - `crop_box: optional object { bottom, left, right, top }` Crop boundaries to process only a portion of each page. Values are ratios 0-1 from page edges - `bottom: optional number` Bottom boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content below this line is excluded - `left: optional number` Left boundary as ratio (0-1). 0=left edge, 1=right edge. Content left of this line is excluded - `right: optional number` Right boundary as ratio (0-1). 0=left edge, 1=right edge. Content right of this line is excluded - `top: optional number` Top boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content above this line is excluded - `disable_cache: optional boolean` Bypass result caching and force re-parsing. Use when document content may have changed or you need fresh results - `fast_options: optional unknown` Options for fast tier parsing (rule-based, no AI). Fast tier uses deterministic algorithms for text extraction without AI enhancement. It's the fastest and most cost-effective option, best suited for simple documents with standard layouts. Currently has no configurable options but reserved for future expansion. - `input_options: optional object { html, pdf, presentation, spreadsheet }` Format-specific options (HTML, PDF, spreadsheet, presentation). Applied based on detected input file type - `html: optional object { make_all_elements_visible, remove_fixed_elements, remove_navigation_elements }` HTML/web page parsing options (applies to .html, .htm files) - `make_all_elements_visible: optional boolean` Force all HTML elements to be visible by overriding CSS display/visibility properties. Useful for parsing pages with hidden content or collapsed sections - `remove_fixed_elements: optional boolean` Remove fixed-position elements (headers, footers, floating buttons) that appear on every page render - `remove_navigation_elements: optional boolean` Remove navigation elements (nav bars, sidebars, menus) to focus on main content - `pdf: optional unknown` PDF-specific parsing options (applies to .pdf files) - `presentation: optional object { out_of_bounds_content, skip_embedded_data }` Presentation parsing options (applies to .pptx, .ppt, .odp, .key files) - `out_of_bounds_content: optional boolean` Extract content positioned outside the visible slide area. Some presentations have hidden notes or content that extends beyond slide boundaries - `skip_embedded_data: optional boolean` Skip extraction of embedded chart data tables. When true, only the visual representation of charts is captured, not the underlying data - `spreadsheet: optional object { detect_sub_tables_in_sheets, force_formula_computation_in_sheets, include_hidden_sheets }` Spreadsheet parsing options (applies to .xlsx, .xls, .csv, .ods files) - `detect_sub_tables_in_sheets: optional boolean` Detect and extract multiple tables within a single sheet. Useful when spreadsheets contain several data regions separated by blank rows/columns - `force_formula_computation_in_sheets: optional boolean` Compute formula results instead of extracting formula text. Use when you need calculated values rather than formula definitions - `include_hidden_sheets: optional boolean` Parse hidden sheets in addition to visible ones. By default, hidden sheets are skipped - `output_options: optional object { extract_printed_page_number, images_to_save, markdown, 2 more }` Output formatting options for markdown, text, and extracted images - `extract_printed_page_number: optional boolean` Extract the printed page number as it appears in the document (e.g., 'Page 5 of 10', 'v', 'A-3'). Useful for referencing original page numbers - `images_to_save: optional array of "screenshot" or "embedded" or "layout"` Image categories to extract and save. Options: 'screenshot' (full page renders useful for visual QA), 'embedded' (images found within the document), 'layout' (cropped regions from layout detection like figures and diagrams). Empty list saves no images - `"screenshot"` - `"embedded"` - `"layout"` - `markdown: optional object { annotate_links, inline_images, tables }` Markdown formatting options including table styles and link annotations - `annotate_links: optional boolean` Add link annotations to markdown output in the format [text](url). When false, only the link text is included - `inline_images: optional boolean` Embed images directly in markdown as base64 data URIs instead of extracting them as separate files. Useful for self-contained markdown output - `tables: optional object { compact_markdown_tables, markdown_table_multiline_separator, merge_continued_tables, output_tables_as_markdown }` Table formatting options including markdown vs HTML format and merging behavior - `compact_markdown_tables: optional boolean` Remove extra whitespace padding in markdown table cells for more compact output - `markdown_table_multiline_separator: optional string` Separator string for multiline cell content in markdown tables. Example: '
' to preserve line breaks, ' ' to join with spaces - `merge_continued_tables: optional boolean` Automatically merge tables that span multiple pages into a single table. The merged table appears on the first page with merged_from_pages metadata - `output_tables_as_markdown: optional boolean` Output tables as markdown pipe tables instead of HTML tags. Markdown tables are simpler but cannot represent complex structures like merged cells - `spatial_text: optional object { do_not_unroll_columns, preserve_layout_alignment_across_pages, preserve_very_small_text }` Spatial text output options for preserving document layout structure - `do_not_unroll_columns: optional boolean` Keep multi-column layouts intact instead of linearizing columns into sequential text. Automatically enabled for non-fast tiers - `preserve_layout_alignment_across_pages: optional boolean` Maintain consistent text column alignment across page boundaries. Automatically enabled for document-level parsing modes - `preserve_very_small_text: optional boolean` Include text below the normal size threshold. Useful for footnotes, watermarks, or fine print that might otherwise be filtered out - `tables_as_spreadsheet: optional object { enable, guess_sheet_name }` Options for exporting tables as XLSX spreadsheets - `enable: optional boolean` Whether this option is enabled - `guess_sheet_name: optional boolean` Automatically generate descriptive sheet names from table context (headers, surrounding text) instead of using generic names like 'Table_1' - `page_ranges: optional object { max_pages, target_pages }` Page selection: limit total pages or specify exact pages to process - `max_pages: optional number` Maximum number of pages to process. Pages are processed in order starting from page 1. If both max_pages and target_pages are set, target_pages takes precedence - `target_pages: optional string` Comma-separated list of specific pages to process using 1-based indexing. Supports individual pages and ranges. Examples: '1,3,5' (pages 1, 3, 5), '1-5' (pages 1 through 5 inclusive), '1,3,5-8,10' (pages 1, 3, 5-8, and 10). Pages are sorted and deduplicated automatically. Duplicate pages cause an error - `processing_control: optional object { job_failure_conditions, timeouts }` Job execution controls including timeouts and failure thresholds - `job_failure_conditions: optional object { allowed_page_failure_ratio, fail_on_buggy_font, fail_on_image_extraction_error, 2 more }` Quality thresholds that determine when a job should fail vs complete with partial results - `allowed_page_failure_ratio: optional number` Maximum ratio of pages allowed to fail before the job fails (0-1). Example: 0.1 means job fails if more than 10% of pages fail. Default is 0.05 (5%) - `fail_on_buggy_font: optional boolean` Fail the job if a problematic font is detected that may cause incorrect text extraction. Buggy fonts can produce garbled or missing characters - `fail_on_image_extraction_error: optional boolean` Fail the entire job if any embedded image cannot be extracted. By default, image extraction errors are logged but don't fail the job - `fail_on_image_ocr_error: optional boolean` Fail the entire job if OCR fails on any image. By default, OCR errors result in empty text for that image - `fail_on_markdown_reconstruction_error: optional boolean` Fail the entire job if markdown cannot be reconstructed for any page. By default, failed pages use fallback text extraction - `timeouts: optional object { base_in_seconds, extra_time_per_page_in_seconds }` Timeout settings for job execution. Increase for large or complex documents - `base_in_seconds: optional number` Base timeout for the job in seconds (max 1800 = 30 minutes). This is the minimum time allowed regardless of document size - `extra_time_per_page_in_seconds: optional number` Additional timeout per page in seconds (max 300 = 5 minutes). Total timeout = base + (this value × page count) - `processing_options: optional object { aggressive_table_extraction, auto_mode_configuration, cost_optimizer, 4 more }` Document processing options including OCR, table extraction, and chart parsing - `aggressive_table_extraction: optional boolean` Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables - `auto_mode_configuration: optional array of object { parsing_conf, filename_match_glob, filename_match_glob_list, 33 more }` Conditional processing rules that apply different parsing options based on page content, document structure, or filename patterns. Each entry defines trigger conditions and the parsing configuration to apply when triggered - `parsing_conf: object { adaptive_long_table, aggressive_table_extraction, crop_box, 11 more }` Parsing configuration to apply when trigger conditions are met - `adaptive_long_table: optional boolean` Whether to use adaptive long table handling - `aggressive_table_extraction: optional boolean` Whether to use aggressive table extraction - `crop_box: optional object { bottom, left, right, top }` Crop box options for auto mode parsing configuration. - `bottom: optional number` Bottom boundary of crop box as ratio (0-1) - `left: optional number` Left boundary of crop box as ratio (0-1) - `right: optional number` Right boundary of crop box as ratio (0-1) - `top: optional number` Top boundary of crop box as ratio (0-1) - `custom_prompt: optional string` Custom AI instructions for matched pages. Overrides the base custom_prompt - `extract_layout: optional boolean` Whether to extract layout information - `high_res_ocr: optional boolean` Whether to use high resolution OCR - `ignore: optional object { ignore_diagonal_text, ignore_hidden_text }` Ignore options for auto mode parsing configuration. - `ignore_diagonal_text: optional boolean` Whether to ignore diagonal text in the document - `ignore_hidden_text: optional boolean` Whether to ignore hidden text in the document - `language: optional string` Primary language of the document - `outlined_table_extraction: optional boolean` Whether to use outlined table extraction - `presentation: optional object { out_of_bounds_content, skip_embedded_data }` Presentation-specific options for auto mode parsing configuration. - `out_of_bounds_content: optional boolean` Extract out of bounds content in presentation slides - `skip_embedded_data: optional boolean` Skip extraction of embedded data for charts in presentation slides - `spatial_text: optional object { do_not_unroll_columns, preserve_layout_alignment_across_pages, preserve_very_small_text }` Spatial text options for auto mode parsing configuration. - `do_not_unroll_columns: optional boolean` Keep column structure intact without unrolling - `preserve_layout_alignment_across_pages: optional boolean` Preserve text alignment across page boundaries - `preserve_very_small_text: optional boolean` Include very small text in spatial output - `specialized_chart_parsing: optional "agentic_plus" or "agentic" or "efficient"` Enable specialized chart parsing with the specified mode - `"agentic_plus"` - `"agentic"` - `"efficient"` - `tier: optional "fast" or "cost_effective" or "agentic" or "agentic_plus"` Override the parsing tier for matched pages. Must be paired with version - `"fast"` - `"cost_effective"` - `"agentic"` - `"agentic_plus"` - `version: optional "2025-12-11" or "2025-12-18" or "2025-12-31" or 40 more or string` Tier version when overriding tier. Required when tier is specified - `"2025-12-11"` - `"2025-12-18"` - `"2025-12-31"` - `"2026-01-08"` - `"2026-01-09"` - `"2026-01-16"` - `"2026-01-21"` - `"2026-01-22"` - `"2026-01-24"` - `"2026-01-29"` - `"2026-01-30"` - `"2026-02-03"` - `"2026-02-18"` - `"2026-02-20"` - `"2026-02-24"` - `"2026-02-26"` - `"2026-03-02"` - `"2026-03-03"` - `"2026-03-04"` - `"2026-03-05"` - `"2026-03-09"` - `"2026-03-10"` - `"2026-03-11"` - `"2026-03-12"` - `"2026-03-17"` - `"2026-03-19"` - `"2026-03-20"` - `"2026-03-22"` - `"2026-03-23"` - `"2026-03-24"` - `"2026-03-25"` - `"2026-03-26"` - `"2026-03-27"` - `"2026-03-30"` - `"2026-03-31"` - `"2026-04-02"` - `"2026-04-06"` - `"2026-04-09"` - `"2026-04-14"` - `"2026-04-19"` - `"2026-04-22"` - `"2026-04-27"` - `"latest"` - `filename_match_glob: optional string` Single glob pattern to match against filename - `filename_match_glob_list: optional array of string` List of glob patterns to match against filename - `filename_regexp: optional string` Regex pattern to match against filename - `filename_regexp_mode: optional string` Regex mode flags (e.g., 'i' for case-insensitive) - `full_page_image_in_page: optional boolean` Trigger if page contains a full-page image (scanned page detection) - `full_page_image_in_page_threshold: optional number or string` Threshold for full page image detection (0.0-1.0, default 0.8) - `union_member_0: number` - `union_member_1: string` - `image_in_page: optional boolean` Trigger if page contains non-screenshot images - `layout_element_in_page: optional string` Trigger if page contains this layout element type - `layout_element_in_page_confidence_threshold: optional number or string` Confidence threshold for layout element detection - `union_member_0: number` - `union_member_1: string` - `page_contains_at_least_n_charts: optional number or string` Trigger if page has more than N charts - `union_member_0: number` - `union_member_1: string` - `page_contains_at_least_n_images: optional number or string` Trigger if page has more than N images - `union_member_0: number` - `union_member_1: string` - `page_contains_at_least_n_layout_elements: optional number or string` Trigger if page has more than N layout elements - `union_member_0: number` - `union_member_1: string` - `page_contains_at_least_n_lines: optional number or string` Trigger if page has more than N lines - `union_member_0: number` - `union_member_1: string` - `page_contains_at_least_n_links: optional number or string` Trigger if page has more than N links - `union_member_0: number` - `union_member_1: string` - `page_contains_at_least_n_numbers: optional number or string` Trigger if page has more than N numeric words - `union_member_0: number` - `union_member_1: string` - `page_contains_at_least_n_percent_numbers: optional number or string` Trigger if page has more than N% numeric words - `union_member_0: number` - `union_member_1: string` - `page_contains_at_least_n_tables: optional number or string` Trigger if page has more than N tables - `union_member_0: number` - `union_member_1: string` - `page_contains_at_least_n_words: optional number or string` Trigger if page has more than N words - `union_member_0: number` - `union_member_1: string` - `page_contains_at_most_n_charts: optional number or string` Trigger if page has fewer than N charts - `union_member_0: number` - `union_member_1: string` - `page_contains_at_most_n_images: optional number or string` Trigger if page has fewer than N images - `union_member_0: number` - `union_member_1: string` - `page_contains_at_most_n_layout_elements: optional number or string` Trigger if page has fewer than N layout elements - `union_member_0: number` - `union_member_1: string` - `page_contains_at_most_n_lines: optional number or string` Trigger if page has fewer than N lines - `union_member_0: number` - `union_member_1: string` - `page_contains_at_most_n_links: optional number or string` Trigger if page has fewer than N links - `union_member_0: number` - `union_member_1: string` - `page_contains_at_most_n_numbers: optional number or string` Trigger if page has fewer than N numeric words - `union_member_0: number` - `union_member_1: string` - `page_contains_at_most_n_percent_numbers: optional number or string` Trigger if page has fewer than N% numeric words - `union_member_0: number` - `union_member_1: string` - `page_contains_at_most_n_tables: optional number or string` Trigger if page has fewer than N tables - `union_member_0: number` - `union_member_1: string` - `page_contains_at_most_n_words: optional number or string` Trigger if page has fewer than N words - `union_member_0: number` - `union_member_1: string` - `page_longer_than_n_chars: optional number or string` Trigger if page has more than N characters - `union_member_0: number` - `union_member_1: string` - `page_md_error: optional boolean` Trigger on pages with markdown extraction errors - `page_shorter_than_n_chars: optional number or string` Trigger if page has fewer than N characters - `union_member_0: number` - `union_member_1: string` - `regexp_in_page: optional string` Regex pattern to match in page content - `regexp_in_page_mode: optional string` Regex mode flags for regexp_in_page - `table_in_page: optional boolean` Trigger if page contains a table - `text_in_page: optional string` Trigger if page text/markdown contains this string - `trigger_mode: optional string` How to combine multiple trigger conditions: 'and' (all conditions must match, this is the default) or 'or' (any single condition can trigger) - `cost_optimizer: optional object { enable }` Cost optimizer configuration for reducing parsing costs on simpler pages. When enabled, the parser analyzes each page and routes simpler pages to faster, cheaper processing while preserving quality for complex pages. Only works with 'agentic' or 'agentic_plus' tiers. - `enable: optional boolean` Enable cost-optimized parsing. Routes simpler pages to faster processing while complex pages use full AI analysis. May reduce speed on some documents. IMPORTANT: Only available with 'agentic' or 'agentic_plus' tiers - `disable_heuristics: optional boolean` Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results - `ignore: optional object { ignore_diagonal_text, ignore_hidden_text, ignore_text_in_image }` Options for ignoring specific text types (diagonal, hidden, text in images) - `ignore_diagonal_text: optional boolean` Skip text rotated at an angle (not horizontal/vertical). Useful for ignoring watermarks or decorative angled text - `ignore_hidden_text: optional boolean` Skip text marked as hidden in the document structure. Some PDFs contain invisible text layers used for accessibility or search indexing - `ignore_text_in_image: optional boolean` Skip OCR text extraction from embedded images. Use when images contain irrelevant text (watermarks, logos) that shouldn't be in the output - `ocr_parameters: optional object { languages }` OCR configuration including language detection settings - `languages: optional array of ParsingLanguages` Languages to use for OCR text recognition. Specify multiple languages if document contains mixed-language content. Order matters - put primary language first. Example: ['en', 'es'] for English with Spanish - `"af"` - `"az"` - `"bs"` - `"cs"` - `"cy"` - `"da"` - `"de"` - `"en"` - `"es"` - `"et"` - `"fr"` - `"ga"` - `"hr"` - `"hu"` - `"id"` - `"is"` - `"it"` - `"ku"` - `"la"` - `"lt"` - `"lv"` - `"mi"` - `"ms"` - `"mt"` - `"nl"` - `"no"` - `"oc"` - `"pi"` - `"pl"` - `"pt"` - `"ro"` - `"rs_latin"` - `"sk"` - `"sl"` - `"sq"` - `"sv"` - `"sw"` - `"tl"` - `"tr"` - `"uz"` - `"vi"` - `"ar"` - `"fa"` - `"ug"` - `"ur"` - `"bn"` - `"as"` - `"mni"` - `"ru"` - `"rs_cyrillic"` - `"be"` - `"bg"` - `"uk"` - `"mn"` - `"abq"` - `"ady"` - `"kbd"` - `"ava"` - `"dar"` - `"inh"` - `"che"` - `"lbe"` - `"lez"` - `"tab"` - `"tjk"` - `"hi"` - `"mr"` - `"ne"` - `"bh"` - `"mai"` - `"ang"` - `"bho"` - `"mah"` - `"sck"` - `"new"` - `"gom"` - `"sa"` - `"bgc"` - `"th"` - `"ch_sim"` - `"ch_tra"` - `"ja"` - `"ko"` - `"ta"` - `"te"` - `"kn"` - `specialized_chart_parsing: optional "agentic_plus" or "agentic" or "efficient"` Enable AI-powered chart analysis. Modes: 'efficient' (fast, lower cost), 'agentic' (balanced), 'agentic_plus' (highest accuracy). Automatically enables extract_layout and precise_bounding_box when set - `"agentic_plus"` - `"agentic"` - `"efficient"` - `webhook_configurations: optional array of object { webhook_events, webhook_headers, webhook_url }` Webhook endpoints for job status notifications. Multiple webhooks can be configured for different events or services - `webhook_events: optional array of string` Events that trigger this webhook. Options: 'parse.success' (job completed), 'parse.failure' (job failed), 'parse.partial' (some pages failed). If not specified, webhook fires for all events - `webhook_headers: optional map[unknown]` Custom HTTP headers to include in webhook requests. Use for authentication tokens or custom routing. Example: {'Authorization': 'Bearer xyz'} - `webhook_url: optional string` HTTPS URL to receive webhook POST requests. Must be publicly accessible - `spreadsheet_v1: object { product_type, extraction_range, flatten_hierarchical_tables, 6 more }` Typed parameters for a *spreadsheet v1* product configuration. - `product_type: "spreadsheet_v1"` Product type. - `"spreadsheet_v1"` - `extraction_range: optional string` A1 notation of the range to extract a single region from. If None, the entire sheet is used. - `flatten_hierarchical_tables: optional boolean` Return a flattened dataframe when a detected table is recognized as hierarchical. - `generate_additional_metadata: optional boolean` Whether to generate additional metadata (title, description) for each extracted region. - `include_hidden_cells: optional boolean` Whether to include hidden cells when extracting regions from the spreadsheet. - `sheet_names: optional array of string` The names of the sheets to extract regions from. If empty, all sheets will be processed. - `specialization: optional string` Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. - `table_merge_sensitivity: optional "strong" or "weak"` Influences how likely similar-looking regions are merged into a single table. Useful for spreadsheets that either have sparse tables (strong merging) or many distinct tables close together (weak merging). - `"strong"` - `"weak"` - `use_experimental_processing: optional boolean` Enables experimental processing. Accuracy may be impacted. - `untyped_parameters: object { product_type }` Catch-all for configurations without a dedicated typed schema. Accepts arbitrary JSON fields alongside `product_type`. - `product_type: "unknown"` Product type. - `"unknown"` ### Example ```cli llamacloud-prod extract generate-schema \ --api-key 'My API Key' ``` #### Response ```json { "name": "x", "parameters": { "categories": [ { "name": "x", "description": "x" } ], "product_type": "split_v1", "splitting_strategy": { "allow_uncategorized": "include" } } } ``` ## Domain Types ### Extract Configuration - `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 - `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 - `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 - `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 - `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 - `extract_v2_job_query_response: object { items, next_page_token, total_size }` Paginated list of extraction jobs. - `items: array of ExtractV2Job` 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 - `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 - `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 - `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 - `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`