Parse a file by file ID or URL.
Provide either file_id (a previously uploaded file) or
source_url (a publicly accessible URL). Configure parsing
with options like tier, target_pages, and lang.
Tiers
fast— rule-based, cheapest, no AIcost_effective— balanced speed and qualityagentic— full AI-powered parsingagentic_plus— premium AI with specialized features
The job runs asynchronously. Poll GET /parse/{job_id} with
expand=text or expand=markdown to retrieve results.
ParametersExpand Collapse
version: Union[Literal["2025-12-11", "2025-12-18", "2025-12-31", 39 more], str]
Tier version. Use ‘latest’ for the current stable version, or specify a specific version (e.g., ‘1.0’, ‘2.0’) for reproducible results
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[str]
Identifier for the client/application making the request. Used for analytics and debugging. Example: ‘my-app-v2’
Crop boundaries to process only a portion of each page. Values are ratios 0-1 from page edges
bottom: Optional[float]
Bottom boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content below this line is excluded
left: Optional[float]
Left boundary as ratio (0-1). 0=left edge, 1=right edge. Content left of this line is excluded
disable_cache: Optional[bool]
Bypass result caching and force re-parsing. Use when document content may have changed or you need fresh results
fast_options: Optional[object]
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.
file_id: Optional[str]
ID of an existing file in the project to parse. Mutually exclusive with source_url
Format-specific options (HTML, PDF, spreadsheet, presentation). Applied based on detected input file type
html: Optional[InputOptionsHTML]
HTML/web page parsing options (applies to .html, .htm files)
make_all_elements_visible: Optional[bool]
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[InputOptionsPresentation]
spreadsheet: Optional[InputOptionsSpreadsheet]
Spreadsheet parsing options (applies to .xlsx, .xls, .csv, .ods files)
detect_sub_tables_in_sheets: Optional[bool]
Detect and extract multiple tables within a single sheet. Useful when spreadsheets contain several data regions separated by blank rows/columns
Output formatting options for markdown, text, and extracted images
extract_printed_page_number: Optional[bool]
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[List[Literal["screenshot", "embedded", "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[OutputOptionsMarkdown]
Markdown formatting options including table styles and link annotations
annotate_links: Optional[bool]
Add link annotations to markdown output in the format text. When false, only the link text is included
inline_images: Optional[bool]
Embed images directly in markdown as base64 data URIs instead of extracting them as separate files. Useful for self-contained markdown output
tables: Optional[OutputOptionsMarkdownTables]
Table formatting options including markdown vs HTML format and merging behavior
compact_markdown_tables: Optional[bool]
Remove extra whitespace padding in markdown table cells for more compact output
markdown_table_multiline_separator: Optional[str]
Separator string for multiline cell content in markdown tables. Example: ‘<br>’ to preserve line breaks, ’ ’ to join with spaces
spatial_text: Optional[OutputOptionsSpatialText]
Spatial text output options for preserving document layout structure
do_not_unroll_columns: Optional[bool]
Keep multi-column layouts intact instead of linearizing columns into sequential text. Automatically enabled for non-fast tiers
Page selection: limit total pages or specify exact pages to process
max_pages: Optional[int]
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[str]
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
Job execution controls including timeouts and failure thresholds
job_failure_conditions: Optional[ProcessingControlJobFailureConditions]
Quality thresholds that determine when a job should fail vs complete with partial results
allowed_page_failure_ratio: Optional[float]
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[bool]
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[bool]
Fail the entire job if any embedded image cannot be extracted. By default, image extraction errors are logged but don’t fail the job
Document processing options including OCR, table extraction, and chart parsing
aggressive_table_extraction: Optional[bool]
Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables
auto_mode_configuration: Optional[Iterable[ProcessingOptionsAutoModeConfiguration]]
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: ProcessingOptionsAutoModeConfigurationParsingConf
Parsing configuration to apply when trigger conditions are met
crop_box: Optional[ProcessingOptionsAutoModeConfigurationParsingConfCropBox]
Crop box options for auto mode parsing configuration.
custom_prompt: Optional[str]
Custom AI instructions for matched pages. Overrides the base custom_prompt
spatial_text: Optional[ProcessingOptionsAutoModeConfigurationParsingConfSpatialText]
Spatial text options for auto mode parsing configuration.
version: Optional[Union[Literal["2025-12-11", "2025-12-18", "2025-12-31", 39 more], str, null]]
filename_match_glob_list: Optional[SequenceNotStr[str]]
List of glob patterns to match against filename
full_page_image_in_page: Optional[bool]
Trigger if page contains a full-page image (scanned page detection)
cost_optimizer: Optional[ProcessingOptionsCostOptimizer]
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[bool]
Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results
ignore: Optional[ProcessingOptionsIgnore]
Options for ignoring specific text types (diagonal, hidden, text in images)
ignore_diagonal_text: Optional[bool]
Skip text rotated at an angle (not horizontal/vertical). Useful for ignoring watermarks or decorative angled text
ocr_parameters: Optional[ProcessingOptionsOcrParameters]
Webhook endpoints for job status notifications. Multiple webhooks can be configured for different events or services
webhook_events: Optional[SequenceNotStr[str]]
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
Parse File
import os
from llama_cloud import LlamaCloud
client = LlamaCloud(
api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted
)
parsing = client.parsing.create(
tier="fast",
version="2025-12-11",
)
print(parsing.id){
"id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"status": "PENDING",
"created_at": "2019-12-27T18:11:19.117Z",
"error_message": "error_message",
"name": "Q4 Financial Report",
"tier": "fast",
"updated_at": "2019-12-27T18:11:19.117Z"
}Returns Examples
{
"id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"status": "PENDING",
"created_at": "2019-12-27T18:11:19.117Z",
"error_message": "error_message",
"name": "Q4 Financial Report",
"tier": "fast",
"updated_at": "2019-12-27T18:11:19.117Z"
}