Get Configuration
Get a single product configuration by ID.
ReturnsExpand Collapse
ConfigurationResponse = object { id, name, parameters, 4 more }
Response schema for a single product configuration.
parameters: SplitV1Parameters { categories, product_type, splitting_strategy } or ExtractV2Parameters { data_schema, product_type, cite_sources, 10 more } or ClassifyV2Parameters { product_type, rules, mode, parsing_configuration } or 2 more
Product-specific configuration parameters.
SplitV1Parameters = object { categories, product_type, splitting_strategy }
Typed parameters for a split v1 product configuration.
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.
ExtractV2Parameters = object { data_schema, product_type, cite_sources, 10 more }
Typed parameters for an extract v2 product configuration.
parse_config_id: optional string
Saved parse configuration ID to control how the document is parsed before extraction
ClassifyV2Parameters = object { product_type, rules, mode, parsing_configuration }
ParseV2Parameters = 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.
version: "2025-12-11" or "2025-12-18" or "2025-12-31" or 33 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
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.
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
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
presentation: optional object { out_of_bounds_content, skip_embedded_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
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
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. 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: ‘<br>’ to preserve line breaks, ’ ’ to join with spaces
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
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
timeouts: optional object { base_in_seconds, extra_time_per_page_in_seconds }
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
crop_box: optional object { bottom, left, right, top }
Crop box options for auto mode parsing configuration.
custom_prompt: optional string
Custom AI instructions for matched pages. Overrides the base custom_prompt
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.
version: optional "2025-12-11" or "2025-12-18" or "2025-12-31" or 33 more or string
full_page_image_in_page: optional boolean
Trigger if page contains a full-page image (scanned page detection)
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.
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
ocr_parameters: optional object { languages }
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
Get Configuration
curl https://api.cloud.llamaindex.ai/api/v1/beta/configurations/$CONFIG_ID \
-H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"{
"id": "id",
"name": "name",
"parameters": {
"categories": [
{
"name": "x",
"description": "x"
}
],
"product_type": "split_v1",
"splitting_strategy": {
"allow_uncategorized": "include"
}
},
"product_type": "split_v1",
"version": "version",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z"
}Returns Examples
{
"id": "id",
"name": "name",
"parameters": {
"categories": [
{
"name": "x",
"description": "x"
}
],
"product_type": "split_v1",
"splitting_strategy": {
"allow_uncategorized": "include"
}
},
"product_type": "split_v1",
"version": "version",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z"
}