# Parsing
## Parse File
**post** `/api/v2/parse`
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 AI
- `cost_effective` — balanced speed and quality
- `agentic` — full AI-powered parsing
- `agentic_plus` — premium AI with specialized features
The job runs asynchronously. Poll `GET /parse/{job_id}` with
`expand=text` or `expand=markdown` to retrieve results.
### Query Parameters
- `organization_id: optional string`
- `project_id: optional string`
### Cookie Parameters
- `session: optional string`
### Body Parameters
- `tier: "fast" or "cost_effective" or "agentic" or "agentic_plus" or string`
Parsing tier: 'fast' (rule-based, cheapest), 'cost_effective' (balanced), 'agentic' (AI-powered with custom prompts), or 'agentic_plus' (premium AI with highest accuracy)
- `"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"`
- `string`
- `version: "latest" or "2026-07-15" or "2026-07-08" or 2 more or string`
Version for the selected tier. Use `latest`, or pin one of that tier's dated versions.
Current `latest` by tier:
- `fast`: `2026-06-15`
- `cost_effective`: `2026-06-26`
- `agentic`: `2026-07-15`
- `agentic_plus`: `2026-07-08`
Full list: `GET /api/v2/parse/versions`.
- `"latest" or "2026-07-15" or "2026-07-08" or 2 more`
Version for the selected tier. Use `latest`, or pin one of that tier's dated versions.
Current `latest` by tier:
- `fast`: `2026-06-15`
- `cost_effective`: `2026-06-26`
- `agentic`: `2026-07-15`
- `agentic_plus`: `2026-07-08`
Full list: `GET /api/v2/parse/versions`.
- `"latest"`
- `"2026-07-15"`
- `"2026-07-08"`
- `"2026-06-26"`
- `"2026-06-15"`
- `string`
- `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'
- `configuration_id: optional string`
ID of a saved parse configuration. When set, `tier` and `version` default to the saved configuration's values — omit them or pass `'configured'`.
- `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.
- `file_id: optional string`
ID of an existing file in the project to parse. Mutually exclusive with source_url
- `http_proxy: optional string`
HTTP/HTTPS proxy for fetching source_url. Ignored if using file_id
- `input_options: optional object { html, image, pdf, 2 more }`
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
- `image: optional object { camera_photo_correction }`
Image parsing options (applies to .jpg, .jpeg, .png, .webp files)
- `camera_photo_correction: optional boolean`
Detect documents photographed with a camera (e.g. phone scans of receipts or forms), then crop, perspective-correct, and flatten uneven lighting and shadows before parsing. Supports JPEG, PNG, WebP, and HEIC/HEIF inputs. Improves results when the document is tilted or surrounded by background. Images that already look like clean scans are left untouched
- `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 { additional_outputs, extract_printed_page_number, granular_bboxes, 4 more }`
Output formatting options for markdown, text, and extracted images
- `additional_outputs: optional array of string`
Optional additional output artifacts to save alongside the primary parse output. Each value opts in to generating and persisting one extra file; the empty list (default) saves none. The three accepted values are: 'stripped_md' — per-page markdown stripped of formatting (links, bold/italic, images, HTML), saved as JSON for full-text-search indexing; fetch via `expand=stripped_markdown_content_metadata`. 'concatenated_stripped_txt' — all stripped pages concatenated into a single plain-text file with `\n\n---\n\n` between pages, useful for feeding the document into search or embedding pipelines as one blob; fetch via `expand=concatenated_stripped_markdown_content_metadata`. 'word_bbox' — raw word-level bounding boxes (one JSON object per word, with page number and x/y/w/h coordinates) saved as JSONL, useful for highlighting or grounding extracted answers back to the source document; fetch via `expand=raw_words_content_metadata`.
- `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
- `granular_bboxes: optional array of "cell" or "line" or "word"`
Bounding-box granularity levels to compute for the parse. 'word' computes one bounding box per detected word; 'line' computes one per text line; 'cell' computes one per table cell. Multiple levels can be requested. Empty list (default) disables granular bboxes — only item-level layout boxes are returned on the result. When set, the computed boxes are not inlined on the result items; they are written to a separate `grounded_items` sidecar (JSONL, one row per page) and exposed as `result_content_metadata.grounded_items` (a presigned download URL) on the parse result. Each row matches the `GroundedJsonItem` shape.
- `"cell"`
- `"line"`
- `"word"`
- `images_to_save: optional array of "embedded" or "layout" or "screenshot"`
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
- `"embedded"`
- `"layout"`
- `"screenshot"`
- `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 7200 = 2 hours). 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, confidence_score_effort, 6 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" or "agentic_plus" or "efficient"`
Enable specialized chart parsing with the specified mode
- `"agentic"`
- `"agentic_plus"`
- `"efficient"`
- `tier: optional "agentic" or "agentic_plus" or "cost_effective" or "fast"`
Override the parsing tier for matched pages. Must be paired with version
- `"agentic"`
- `"agentic_plus"`
- `"cost_effective"`
- `"fast"`
- `version: optional "latest" or "2026-07-15" or "2026-07-08" or 2 more or string`
Version for the override tier. Required when `tier` is set. Use `latest`, or pin one of that tier's dated versions.
Current `latest` by tier:
- `fast`: `2026-06-15`
- `cost_effective`: `2026-06-26`
- `agentic`: `2026-07-15`
- `agentic_plus`: `2026-07-08`
Full list: `GET /api/v2/parse/versions`.
- `"latest" or "2026-07-15" or "2026-07-08" or 2 more`
Version for the override tier. Required when `tier` is set. Use `latest`, or pin one of that tier's dated versions.
Current `latest` by tier:
- `fast`: `2026-06-15`
- `cost_effective`: `2026-06-26`
- `agentic`: `2026-07-15`
- `agentic_plus`: `2026-07-08`
Full list: `GET /api/v2/parse/versions`.
- `"latest"`
- `"2026-07-15"`
- `"2026-07-08"`
- `"2026-06-26"`
- `"2026-06-15"`
- `string`
- `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)
- `number`
- `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
- `number`
- `string`
- `page_contains_at_least_n_charts: optional number or string`
Trigger if page has more than N charts
- `number`
- `string`
- `page_contains_at_least_n_images: optional number or string`
Trigger if page has more than N images
- `number`
- `string`
- `page_contains_at_least_n_layout_elements: optional number or string`
Trigger if page has more than N layout elements
- `number`
- `string`
- `page_contains_at_least_n_lines: optional number or string`
Trigger if page has more than N lines
- `number`
- `string`
- `page_contains_at_least_n_links: optional number or string`
Trigger if page has more than N links
- `number`
- `string`
- `page_contains_at_least_n_numbers: optional number or string`
Trigger if page has more than N numeric words
- `number`
- `string`
- `page_contains_at_least_n_percent_numbers: optional number or string`
Trigger if page has more than N% numeric words
- `number`
- `string`
- `page_contains_at_least_n_tables: optional number or string`
Trigger if page has more than N tables
- `number`
- `string`
- `page_contains_at_least_n_words: optional number or string`
Trigger if page has more than N words
- `number`
- `string`
- `page_contains_at_most_n_charts: optional number or string`
Trigger if page has fewer than N charts
- `number`
- `string`
- `page_contains_at_most_n_images: optional number or string`
Trigger if page has fewer than N images
- `number`
- `string`
- `page_contains_at_most_n_layout_elements: optional number or string`
Trigger if page has fewer than N layout elements
- `number`
- `string`
- `page_contains_at_most_n_lines: optional number or string`
Trigger if page has fewer than N lines
- `number`
- `string`
- `page_contains_at_most_n_links: optional number or string`
Trigger if page has fewer than N links
- `number`
- `string`
- `page_contains_at_most_n_numbers: optional number or string`
Trigger if page has fewer than N numeric words
- `number`
- `string`
- `page_contains_at_most_n_percent_numbers: optional number or string`
Trigger if page has fewer than N% numeric words
- `number`
- `string`
- `page_contains_at_most_n_tables: optional number or string`
Trigger if page has fewer than N tables
- `number`
- `string`
- `page_contains_at_most_n_words: optional number or string`
Trigger if page has fewer than N words
- `number`
- `string`
- `page_longer_than_n_chars: optional number or string`
Trigger if page has more than N characters
- `number`
- `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
- `number`
- `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)
- `confidence_score_effort: optional "high"`
Confidence scoring effort. Omit for standard scoring. 'high': more accurate assessment of the parsing quality of every page, plus a document-level score in the result metadata; costs an additional 5 credits per page
- `"high"`
- `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
- `forms: optional "default" or "enrich"`
Beta: set to 'enrich' to run an additional AI form-analysis pass on pages detected as forms, producing a structured tree of the form's sections, fields, and fillable grids. Retrieve the result with expand=forms. 'default' (the default) applies standard parsing with no extra pass. Not available on the fast tier
- `"default"`
- `"enrich"`
- `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
- `"abq"`
- `"ady"`
- `"af"`
- `"ang"`
- `"ar"`
- `"as"`
- `"ava"`
- `"az"`
- `"be"`
- `"bg"`
- `"bgc"`
- `"bh"`
- `"bho"`
- `"bn"`
- `"bs"`
- `"ch_sim"`
- `"ch_tra"`
- `"che"`
- `"cs"`
- `"cy"`
- `"da"`
- `"dar"`
- `"de"`
- `"en"`
- `"es"`
- `"et"`
- `"fa"`
- `"fr"`
- `"ga"`
- `"gom"`
- `"hi"`
- `"hr"`
- `"hu"`
- `"id"`
- `"inh"`
- `"is"`
- `"it"`
- `"ja"`
- `"kbd"`
- `"kn"`
- `"ko"`
- `"ku"`
- `"la"`
- `"lbe"`
- `"lez"`
- `"lt"`
- `"lv"`
- `"mah"`
- `"mai"`
- `"mi"`
- `"mn"`
- `"mni"`
- `"mr"`
- `"ms"`
- `"mt"`
- `"ne"`
- `"new"`
- `"nl"`
- `"no"`
- `"oc"`
- `"pi"`
- `"pl"`
- `"pt"`
- `"ro"`
- `"rs_cyrillic"`
- `"rs_latin"`
- `"ru"`
- `"sa"`
- `"sck"`
- `"sk"`
- `"sl"`
- `"sq"`
- `"sv"`
- `"sw"`
- `"ta"`
- `"tab"`
- `"te"`
- `"th"`
- `"tjk"`
- `"tl"`
- `"tr"`
- `"ug"`
- `"uk"`
- `"ur"`
- `"uz"`
- `"vi"`
- `specialized_chart_parsing: optional "agentic" or "agentic_plus" 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"`
- `"agentic_plus"`
- `"efficient"`
- `source_url: optional string`
Public URL of the document to parse. Mutually exclusive with file_id
- `user_metadata: optional map[string]`
Arbitrary key/value tags to attach to this job. Returned when retrieving the job. Not searchable. Limits apply to the number of entries and the length of keys and values; oversized metadata is rejected.
- `webhook_configuration_ids: optional array of string`
IDs of saved webhook configurations to notify for this job.
- `webhook_configurations: optional array of object { webhook_events, webhook_headers, webhook_output_format, 2 more }`
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.error' (job failed), 'parse.partial_success' (some pages failed), 'parse.pending', 'parse.running', 'parse.cancelled'. 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_output_format: optional "json" or "string"`
Format of the webhook payload body. 'string' (default) sends the payload as a JSON-encoded string; 'json' sends it as a JSON object.
- `"json"`
- `"string"`
- `webhook_signing_secret: optional string`
Shared signing secret used to sign webhook deliveries. When set, each request includes an HMAC-SHA256 signature of the request body in the 'LC-Signature' header (value 'sha256='). Recompute the HMAC over the raw request body with this secret to verify the delivery is authentic.
- `webhook_url: optional string`
HTTPS URL to receive webhook POST requests. Must be publicly accessible
### Returns
- `id: string`
Unique parse job identifier
- `project_id: string`
Project this job belongs to
- `status: "CANCELLED" or "COMPLETED" or "FAILED" or 2 more`
Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
- `"CANCELLED"`
- `"COMPLETED"`
- `"FAILED"`
- `"PENDING"`
- `"RUNNING"`
- `created_at: optional string`
Creation datetime
- `error_message: optional string`
Error details when status is FAILED
- `name: optional string`
Optional display name for this parse job
- `tier: optional string`
Parsing tier used for this job
- `updated_at: optional string`
Update datetime
- `user_metadata: optional map[string]`
Key/value tags associated with this job.
### Example
```http
curl https://api.cloud.llamaindex.ai/api/v2/parse \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
-d '{
"tier": "fast",
"version": "latest"
}'
```
#### Response
```json
{
"id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"status": "CANCELLED",
"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",
"user_metadata": {
"owner": "jerry",
"team": "research"
}
}
```
## Get Parse Job
**get** `/api/v2/parse/{job_id}`
Retrieve a parse job with optional expanded content.
By default returns job metadata only. Use `expand` to include
parsed content:
- `text` — plain text output
- `markdown` — markdown output
- `items` — structured page-by-page output
- `job_metadata` — usage and processing details
Content metadata fields (e.g. `text_content_metadata`) return
presigned URLs for downloading large results.
### Path Parameters
- `job_id: string`
### Query Parameters
- `expand: optional array of string`
Fields to include: text, markdown, items, metadata, forms, job_metadata, text_content_metadata, markdown_content_metadata, items_content_metadata, metadata_content_metadata, forms_content_metadata, raw_words_content_metadata, xlsx_content_metadata, output_pdf_content_metadata, images_content_metadata. Metadata fields include presigned URLs.
- `image_filenames: optional string`
Filter to specific image filenames (optional). Example: image_0.png,image_1.jpg
- `organization_id: optional string`
- `project_id: optional string`
### Cookie Parameters
- `session: optional string`
### Returns
- `job: object { id, project_id, status, 6 more }`
Parse job status and metadata
- `id: string`
Unique parse job identifier
- `project_id: string`
Project this job belongs to
- `status: "CANCELLED" or "COMPLETED" or "FAILED" or 2 more`
Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
- `"CANCELLED"`
- `"COMPLETED"`
- `"FAILED"`
- `"PENDING"`
- `"RUNNING"`
- `created_at: optional string`
Creation datetime
- `error_message: optional string`
Error details when status is FAILED
- `name: optional string`
Optional display name for this parse job
- `tier: optional string`
Parsing tier used for this job
- `updated_at: optional string`
Update datetime
- `user_metadata: optional map[string]`
Key/value tags associated with this job.
- `forms: optional object { pages }`
Per-page form analysis results (one entry per page).
- `pages: array of object { forms, page_number, success } or object { error, page_number, success }`
List of form pages or failed page entries
- `FormsResultPage object { forms, page_number, success }`
Forms found on one page. Pages without form content have an empty forms list.
- `forms: array of Form`
Forms detected on the page
- `json: array of FormField or FormSection or FormTable`
Structured representation: an ordered tree of sections, fields, and tables
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `field: "checkbox" or "multi_select" or "signature" or 2 more`
Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature
- `"checkbox"`
- `"multi_select"`
- `"signature"`
- `"single_select"`
- `"text"`
- `id: optional string`
Field number/letter printed on the form (e.g. '1a'), if any
- `isEmpty: optional boolean`
True for a printed-but-blank text field (mutually exclusive with value)
- `label: optional string`
Printed field caption, if any
- `type: optional "field"`
Form field node
- `"field"`
- `value: optional string or boolean`
Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups
- `string`
- `boolean`
- `valueItems: optional array of FormField or FormSection or FormTable`
Options of a single_select/multi_select group (only on select fields)
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `items: array of FormField or FormSection or FormTable`
Child form nodes in reading order
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `rows: array of array of string or FormTableCellItems`
Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell's own form nodes
- `string`
- `FormTableCellItems object { items }`
A table cell holding its own form nodes (e.g. a checkbox column).
- `items: array of FormField or FormSection or FormTable`
Form nodes inside the cell
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `id: optional string`
Identifier printed on the form, if any
- `columns: optional array of string`
Printed column headers in order, if any
- `label: optional string`
Printed table caption, if any
- `type: optional "table"`
Form table node
- `"table"`
- `id: optional string`
Identifier printed on the form (e.g. 'Part III'), if any
- `label: optional string`
Printed section heading, if any
- `type: optional "section"`
Form section node
- `"section"`
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `list: FormListItem`
Flattened list representation of the same content
- `items: array of FormListTextItem or FormListItem`
Nested lines and sub-lists, in the form's reading order
- `FormListTextItem object { md, value, type }`
One line of a form's list representation.
- `md: string`
Markdown representation of the line
- `value: string`
Line content (e.g. '[1a] Wages: 29,513')
- `type: optional "text"`
Text line
- `"text"`
- `FormListItem object { items, md, ordered, type }`
The list representation of form content: nested lists of rendered field lines.
- `md: string`
Markdown representation of this list
- `ordered: boolean`
Whether the list is ordered
- `type: optional "list"`
List node
- `"list"`
- `page_number: number`
Page number of the document
- `success: true`
Success indicator
- `true`
- `FailedFormsPage object { error, page_number, success }`
A page whose processing failed.
- `error: string`
Error message describing the failure
- `page_number: number`
Page number of the document
- `success: false`
Failure indicator
- `false`
- `images_content_metadata: optional object { images, total_count }`
Metadata for all extracted images.
- `images: array of object { filename, index, bbox, 4 more }`
List of image metadata with presigned URLs
- `filename: string`
Image filename (e.g., 'image_0.png')
- `index: number`
Index of the image in the extraction order
- `bbox: optional object { h, w, x, y }`
Bounding box for an image on its page.
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `category: optional "embedded" or "layout" or "screenshot"`
Image category: 'screenshot' (full page), 'embedded' (images in document), or 'layout' (cropped from layout detection)
- `"embedded"`
- `"layout"`
- `"screenshot"`
- `content_type: optional string`
MIME type of the image
- `presigned_url: optional string`
Presigned URL to download the image
- `size_bytes: optional number`
Deprecated: always returns None. Will be removed in a future release.
- `total_count: number`
Total number of extracted images
- `items: optional object { pages }`
Structured JSON result (if requested)
- `pages: array of object { items, page_height, page_number, 2 more } or object { error, page_number, success }`
List of structured pages or failed page entries
- `StructuredResultPage object { items, page_height, page_number, 2 more }`
- `items: array of CodeItem or FooterItem or HeaderItem or 6 more`
List of structured items on the page
- `CodeItem object { md, value, bbox, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Code content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `language: optional string`
Programming language identifier
- `type: optional "code"`
Code block item type
- `"code"`
- `FooterItem object { items, md, bbox, type }`
- `items: array of CodeItem or HeadingItem or ImageItem or 4 more`
List of items within the footer
- `CodeItem object { md, value, bbox, 2 more }`
- `HeadingItem object { level, md, value, 2 more }`
- `level: number`
Heading level (1-6)
- `md: string`
Markdown representation preserving formatting
- `value: string`
Heading text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "heading"`
Heading item type
- `"heading"`
- `ImageItem object { caption, md, url, 2 more }`
- `caption: string`
Image caption
- `md: string`
Markdown representation preserving formatting
- `url: string`
URL to the image
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "image"`
Image item type
- `"image"`
- `LinkItem object { md, text, url, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `text: string`
Display text of the link
- `url: string`
URL of the link
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "link"`
Link item type
- `"link"`
- `ListItem object { items, md, ordered, 2 more }`
- `items: array of TextItem or ListItem`
List of nested text or list items
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "text"`
Text item type
- `"text"`
- `ListItem object { items, md, ordered, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `ordered: boolean`
Whether the list is ordered or unordered
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "list"`
List item type
- `"list"`
- `TableItem object { csv, html, md, 6 more }`
- `csv: string`
CSV representation of the table
- `html: string`
HTML representation of the table
- `md: string`
Markdown representation preserving formatting
- `rows: array of array of string or number`
Table data as array of arrays (string, number, or null)
- `string`
- `number`
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `merged_from_pages: optional array of number`
List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])
- `merged_into_page: optional number`
Populated when merged into another table. Page number where the full merged table begins (used on empty tables).
- `parse_concerns: optional array of object { details, type }`
Quality concerns detected during table extraction, indicating the table may have issues
- `details: string`
Human-readable details about the concern
- `type: string`
Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)
- `type: optional "table"`
Table item type
- `"table"`
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "footer"`
Page footer container
- `"footer"`
- `HeaderItem object { items, md, bbox, type }`
- `items: array of CodeItem or HeadingItem or ImageItem or 4 more`
List of items within the header
- `CodeItem object { md, value, bbox, 2 more }`
- `HeadingItem object { level, md, value, 2 more }`
- `ImageItem object { caption, md, url, 2 more }`
- `LinkItem object { md, text, url, 2 more }`
- `ListItem object { items, md, ordered, 2 more }`
- `TableItem object { csv, html, md, 6 more }`
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "header"`
Page header container
- `"header"`
- `HeadingItem object { level, md, value, 2 more }`
- `ImageItem object { caption, md, url, 2 more }`
- `LinkItem object { md, text, url, 2 more }`
- `ListItem object { items, md, ordered, 2 more }`
- `TableItem object { csv, html, md, 6 more }`
- `TextItem object { md, value, bbox, type }`
- `page_height: number`
Height of the page in points
- `page_number: number`
Page number of the document
- `page_width: number`
Width of the page in points
- `success: true`
Success indicator
- `true`
- `FailedStructuredPage object { error, page_number, success }`
- `error: string`
Error message describing the failure
- `page_number: number`
Page number of the document
- `success: false`
Failure indicator
- `false`
- `job_metadata: optional map[unknown]`
Job execution metadata (if requested)
- `markdown: optional object { pages }`
Markdown result (if requested)
- `pages: array of object { markdown, page_number, success, 2 more } or object { error, page_number, success }`
List of markdown pages or failed page entries
- `MarkdownResultPage object { markdown, page_number, success, 2 more }`
- `markdown: string`
Markdown content of the page
- `page_number: number`
Page number of the document
- `success: true`
Success indicator
- `true`
- `footer: optional string`
Footer of the page in markdown
- `header: optional string`
Header of the page in markdown
- `FailedMarkdownPage object { error, page_number, success }`
- `error: string`
Error message describing the failure
- `page_number: number`
Page number of the document
- `success: false`
Failure indicator
- `false`
- `markdown_full: optional string`
Full raw markdown content (if requested)
- `metadata: optional object { pages }`
Result containing metadata (page level and general) for the parsed document.
- `pages: array of object { page_number, confidence, cost_optimized, 5 more }`
List of page metadata entries
- `page_number: number`
Page number of the document
- `confidence: optional number`
Confidence score for the page parsing (0-1)
- `cost_optimized: optional boolean`
Whether cost-optimized parsing was used for the page
- `original_orientation_angle: optional number`
Original orientation angle of the page in degrees
- `printed_page_number: optional string`
Printed page number as it appears in the document
- `slide_section_name: optional string`
Section name from presentation slides
- `speaker_notes: optional string`
Speaker notes from presentation slides
- `triggered_auto_mode: optional boolean`
Whether auto mode was triggered for the page
- `raw_parameters: optional map[unknown]`
- `result_content_metadata: optional map[object { size_bytes, exists, presigned_url } ]`
Metadata including size, existence, and presigned URLs for result files
- `size_bytes: number`
Size of the result file in bytes
- `exists: optional boolean`
Whether the result file exists in S3
- `presigned_url: optional string`
Presigned URL to download the result file
- `text: optional object { pages }`
Plain text result (if requested)
- `pages: array of object { page_number, text }`
List of text pages
- `page_number: number`
Page number of the document
- `text: string`
Plain text content of the page
- `text_full: optional string`
Full raw text content (if requested)
### Example
```http
curl https://api.cloud.llamaindex.ai/api/v2/parse/$JOB_ID \
-H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"
```
#### Response
```json
{
"job": {
"id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"status": "CANCELLED",
"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",
"user_metadata": {
"owner": "jerry",
"team": "research"
}
},
"forms": {
"pages": [
{
"forms": [
{
"json": [
{
"field": "checkbox",
"id": "id",
"isEmpty": true,
"label": "label",
"type": "field",
"value": "string",
"valueItems": [
{
"items": [
{
"rows": [
[
"string"
]
],
"id": "id",
"columns": [
"string"
],
"label": "label",
"type": "table"
}
],
"id": "id",
"label": "label",
"type": "section"
}
]
}
],
"list": {
"items": [
{
"md": "md",
"value": "value",
"type": "text"
}
],
"md": "md",
"ordered": true,
"type": "list"
}
}
],
"page_number": 0,
"success": true
}
]
},
"images_content_metadata": {
"images": [
{
"filename": "filename",
"index": 0,
"bbox": {
"h": 0,
"w": 0,
"x": 0,
"y": 0
},
"category": "embedded",
"content_type": "content_type",
"presigned_url": "presigned_url",
"size_bytes": 0
}
],
"total_count": 0
},
"items": {
"pages": [
{
"items": [
{
"md": "md",
"value": "value",
"bbox": [
{
"h": 0,
"w": 0,
"x": 0,
"y": 0,
"confidence": 0,
"end_index": 0,
"label": "label",
"r": 0,
"start_index": 0
}
],
"language": "language",
"type": "code"
}
],
"page_height": 0,
"page_number": 0,
"page_width": 0,
"success": true
}
]
},
"job_metadata": {
"foo": "bar"
},
"markdown": {
"pages": [
{
"markdown": "markdown",
"page_number": 0,
"success": true,
"footer": "footer",
"header": "header"
}
]
},
"markdown_full": "markdown_full",
"metadata": {
"pages": [
{
"page_number": 0,
"confidence": 0,
"cost_optimized": true,
"original_orientation_angle": 0,
"printed_page_number": "printed_page_number",
"slide_section_name": "slide_section_name",
"speaker_notes": "speaker_notes",
"triggered_auto_mode": true
}
]
},
"raw_parameters": {
"foo": "bar"
},
"result_content_metadata": {
"foo": {
"size_bytes": 0,
"exists": true,
"presigned_url": "presigned_url"
}
},
"text": {
"pages": [
{
"page_number": 0,
"text": "text"
}
]
},
"text_full": "text_full"
}
```
## List Parse Jobs
**get** `/api/v2/parse`
List parse jobs for the current project.
Filter by `status` or creation date range. Results are
paginated — use `page_token` from the response to fetch
subsequent pages.
### Query Parameters
- `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)
- `job_ids: 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 "CANCELLED" or "COMPLETED" or "FAILED" or 2 more`
Filter by job status (PENDING, RUNNING, COMPLETED, FAILED, CANCELLED)
- `"CANCELLED"`
- `"COMPLETED"`
- `"FAILED"`
- `"PENDING"`
- `"RUNNING"`
### Cookie Parameters
- `session: optional string`
### Returns
- `items: array of object { id, project_id, status, 6 more }`
The list of items.
- `id: string`
Unique parse job identifier
- `project_id: string`
Project this job belongs to
- `status: "CANCELLED" or "COMPLETED" or "FAILED" or 2 more`
Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
- `"CANCELLED"`
- `"COMPLETED"`
- `"FAILED"`
- `"PENDING"`
- `"RUNNING"`
- `created_at: optional string`
Creation datetime
- `error_message: optional string`
Error details when status is FAILED
- `name: optional string`
Optional display name for this parse job
- `tier: optional string`
Parsing tier used for this job
- `updated_at: optional string`
Update datetime
- `user_metadata: optional map[string]`
Key/value tags associated with this job.
- `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
```http
curl https://api.cloud.llamaindex.ai/api/v2/parse \
-H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"
```
#### Response
```json
{
"items": [
{
"id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"status": "CANCELLED",
"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",
"user_metadata": {
"owner": "jerry",
"team": "research"
}
}
],
"next_page_token": "next_page_token",
"total_size": 0
}
```
## Domain Types
### B Box
- `BBox object { h, w, x, 6 more }`
Bounding box with coordinates and optional metadata.
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
### Code Item
- `CodeItem object { md, value, bbox, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Code content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `language: optional string`
Programming language identifier
- `type: optional "code"`
Code block item type
- `"code"`
### Fail Page Mode
- `FailPageMode = "blank_page" or "error_message" or "raw_text"`
Enum for representing the different available page error handling modes.
- `"blank_page"`
- `"error_message"`
- `"raw_text"`
### Footer Item
- `FooterItem object { items, md, bbox, type }`
- `items: array of CodeItem or HeadingItem or ImageItem or 4 more`
List of items within the footer
- `CodeItem object { md, value, bbox, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Code content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `language: optional string`
Programming language identifier
- `type: optional "code"`
Code block item type
- `"code"`
- `HeadingItem object { level, md, value, 2 more }`
- `level: number`
Heading level (1-6)
- `md: string`
Markdown representation preserving formatting
- `value: string`
Heading text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "heading"`
Heading item type
- `"heading"`
- `ImageItem object { caption, md, url, 2 more }`
- `caption: string`
Image caption
- `md: string`
Markdown representation preserving formatting
- `url: string`
URL to the image
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "image"`
Image item type
- `"image"`
- `LinkItem object { md, text, url, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `text: string`
Display text of the link
- `url: string`
URL of the link
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "link"`
Link item type
- `"link"`
- `ListItem object { items, md, ordered, 2 more }`
- `items: array of TextItem or ListItem`
List of nested text or list items
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "text"`
Text item type
- `"text"`
- `ListItem object { items, md, ordered, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `ordered: boolean`
Whether the list is ordered or unordered
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "list"`
List item type
- `"list"`
- `TableItem object { csv, html, md, 6 more }`
- `csv: string`
CSV representation of the table
- `html: string`
HTML representation of the table
- `md: string`
Markdown representation preserving formatting
- `rows: array of array of string or number`
Table data as array of arrays (string, number, or null)
- `string`
- `number`
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `merged_from_pages: optional array of number`
List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])
- `merged_into_page: optional number`
Populated when merged into another table. Page number where the full merged table begins (used on empty tables).
- `parse_concerns: optional array of object { details, type }`
Quality concerns detected during table extraction, indicating the table may have issues
- `details: string`
Human-readable details about the concern
- `type: string`
Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)
- `type: optional "table"`
Table item type
- `"table"`
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "footer"`
Page footer container
- `"footer"`
### Form
- `Form object { json, list }`
One form detected on a page, in two representations of the same content.
- `json: array of FormField or FormSection or FormTable`
Structured representation: an ordered tree of sections, fields, and tables
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `field: "checkbox" or "multi_select" or "signature" or 2 more`
Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature
- `"checkbox"`
- `"multi_select"`
- `"signature"`
- `"single_select"`
- `"text"`
- `id: optional string`
Field number/letter printed on the form (e.g. '1a'), if any
- `isEmpty: optional boolean`
True for a printed-but-blank text field (mutually exclusive with value)
- `label: optional string`
Printed field caption, if any
- `type: optional "field"`
Form field node
- `"field"`
- `value: optional string or boolean`
Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups
- `string`
- `boolean`
- `valueItems: optional array of FormField or FormSection or FormTable`
Options of a single_select/multi_select group (only on select fields)
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `items: array of FormField or FormSection or FormTable`
Child form nodes in reading order
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `rows: array of array of string or FormTableCellItems`
Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell's own form nodes
- `string`
- `FormTableCellItems object { items }`
A table cell holding its own form nodes (e.g. a checkbox column).
- `items: array of FormField or FormSection or FormTable`
Form nodes inside the cell
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `id: optional string`
Identifier printed on the form, if any
- `columns: optional array of string`
Printed column headers in order, if any
- `label: optional string`
Printed table caption, if any
- `type: optional "table"`
Form table node
- `"table"`
- `id: optional string`
Identifier printed on the form (e.g. 'Part III'), if any
- `label: optional string`
Printed section heading, if any
- `type: optional "section"`
Form section node
- `"section"`
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `list: FormListItem`
Flattened list representation of the same content
- `items: array of FormListTextItem or FormListItem`
Nested lines and sub-lists, in the form's reading order
- `FormListTextItem object { md, value, type }`
One line of a form's list representation.
- `md: string`
Markdown representation of the line
- `value: string`
Line content (e.g. '[1a] Wages: 29,513')
- `type: optional "text"`
Text line
- `"text"`
- `FormListItem object { items, md, ordered, type }`
The list representation of form content: nested lists of rendered field lines.
- `md: string`
Markdown representation of this list
- `ordered: boolean`
Whether the list is ordered
- `type: optional "list"`
List node
- `"list"`
### Form Field
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `field: "checkbox" or "multi_select" or "signature" or 2 more`
Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature
- `"checkbox"`
- `"multi_select"`
- `"signature"`
- `"single_select"`
- `"text"`
- `id: optional string`
Field number/letter printed on the form (e.g. '1a'), if any
- `isEmpty: optional boolean`
True for a printed-but-blank text field (mutually exclusive with value)
- `label: optional string`
Printed field caption, if any
- `type: optional "field"`
Form field node
- `"field"`
- `value: optional string or boolean`
Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups
- `string`
- `boolean`
- `valueItems: optional array of FormField or FormSection or FormTable`
Options of a single_select/multi_select group (only on select fields)
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `items: array of FormField or FormSection or FormTable`
Child form nodes in reading order
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `rows: array of array of string or FormTableCellItems`
Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell's own form nodes
- `string`
- `FormTableCellItems object { items }`
A table cell holding its own form nodes (e.g. a checkbox column).
- `items: array of FormField or FormSection or FormTable`
Form nodes inside the cell
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `id: optional string`
Identifier printed on the form, if any
- `columns: optional array of string`
Printed column headers in order, if any
- `label: optional string`
Printed table caption, if any
- `type: optional "table"`
Form table node
- `"table"`
- `id: optional string`
Identifier printed on the form (e.g. 'Part III'), if any
- `label: optional string`
Printed section heading, if any
- `type: optional "section"`
Form section node
- `"section"`
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
### Form List Item
- `FormListItem object { items, md, ordered, type }`
The list representation of form content: nested lists of rendered field lines.
- `items: array of FormListTextItem or FormListItem`
Nested lines and sub-lists, in the form's reading order
- `FormListTextItem object { md, value, type }`
One line of a form's list representation.
- `md: string`
Markdown representation of the line
- `value: string`
Line content (e.g. '[1a] Wages: 29,513')
- `type: optional "text"`
Text line
- `"text"`
- `FormListItem object { items, md, ordered, type }`
The list representation of form content: nested lists of rendered field lines.
- `md: string`
Markdown representation of this list
- `ordered: boolean`
Whether the list is ordered
- `type: optional "list"`
List node
- `"list"`
### Form List Text Item
- `FormListTextItem object { md, value, type }`
One line of a form's list representation.
- `md: string`
Markdown representation of the line
- `value: string`
Line content (e.g. '[1a] Wages: 29,513')
- `type: optional "text"`
Text line
- `"text"`
### Form Section
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `items: array of FormField or FormSection or FormTable`
Child form nodes in reading order
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `field: "checkbox" or "multi_select" or "signature" or 2 more`
Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature
- `"checkbox"`
- `"multi_select"`
- `"signature"`
- `"single_select"`
- `"text"`
- `id: optional string`
Field number/letter printed on the form (e.g. '1a'), if any
- `isEmpty: optional boolean`
True for a printed-but-blank text field (mutually exclusive with value)
- `label: optional string`
Printed field caption, if any
- `type: optional "field"`
Form field node
- `"field"`
- `value: optional string or boolean`
Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups
- `string`
- `boolean`
- `valueItems: optional array of FormField or FormSection or FormTable`
Options of a single_select/multi_select group (only on select fields)
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `rows: array of array of string or FormTableCellItems`
Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell's own form nodes
- `string`
- `FormTableCellItems object { items }`
A table cell holding its own form nodes (e.g. a checkbox column).
- `items: array of FormField or FormSection or FormTable`
Form nodes inside the cell
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `id: optional string`
Identifier printed on the form, if any
- `columns: optional array of string`
Printed column headers in order, if any
- `label: optional string`
Printed table caption, if any
- `type: optional "table"`
Form table node
- `"table"`
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `id: optional string`
Identifier printed on the form (e.g. 'Part III'), if any
- `label: optional string`
Printed section heading, if any
- `type: optional "section"`
Form section node
- `"section"`
### Form Table
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `rows: array of array of string or FormTableCellItems`
Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell's own form nodes
- `string`
- `FormTableCellItems object { items }`
A table cell holding its own form nodes (e.g. a checkbox column).
- `items: array of FormField or FormSection or FormTable`
Form nodes inside the cell
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `field: "checkbox" or "multi_select" or "signature" or 2 more`
Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature
- `"checkbox"`
- `"multi_select"`
- `"signature"`
- `"single_select"`
- `"text"`
- `id: optional string`
Field number/letter printed on the form (e.g. '1a'), if any
- `isEmpty: optional boolean`
True for a printed-but-blank text field (mutually exclusive with value)
- `label: optional string`
Printed field caption, if any
- `type: optional "field"`
Form field node
- `"field"`
- `value: optional string or boolean`
Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups
- `string`
- `boolean`
- `valueItems: optional array of FormField or FormSection or FormTable`
Options of a single_select/multi_select group (only on select fields)
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `items: array of FormField or FormSection or FormTable`
Child form nodes in reading order
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `id: optional string`
Identifier printed on the form (e.g. 'Part III'), if any
- `label: optional string`
Printed section heading, if any
- `type: optional "section"`
Form section node
- `"section"`
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `id: optional string`
Identifier printed on the form, if any
- `columns: optional array of string`
Printed column headers in order, if any
- `label: optional string`
Printed table caption, if any
- `type: optional "table"`
Form table node
- `"table"`
### Form Table Cell Items
- `FormTableCellItems object { items }`
A table cell holding its own form nodes (e.g. a checkbox column).
- `items: array of FormField or FormSection or FormTable`
Form nodes inside the cell
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `field: "checkbox" or "multi_select" or "signature" or 2 more`
Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature
- `"checkbox"`
- `"multi_select"`
- `"signature"`
- `"single_select"`
- `"text"`
- `id: optional string`
Field number/letter printed on the form (e.g. '1a'), if any
- `isEmpty: optional boolean`
True for a printed-but-blank text field (mutually exclusive with value)
- `label: optional string`
Printed field caption, if any
- `type: optional "field"`
Form field node
- `"field"`
- `value: optional string or boolean`
Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups
- `string`
- `boolean`
- `valueItems: optional array of FormField or FormSection or FormTable`
Options of a single_select/multi_select group (only on select fields)
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `items: array of FormField or FormSection or FormTable`
Child form nodes in reading order
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `rows: array of array of string or FormTableCellItems`
Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell's own form nodes
- `string`
- `FormTableCellItems object { items }`
A table cell holding its own form nodes (e.g. a checkbox column).
- `id: optional string`
Identifier printed on the form, if any
- `columns: optional array of string`
Printed column headers in order, if any
- `label: optional string`
Printed table caption, if any
- `type: optional "table"`
Form table node
- `"table"`
- `id: optional string`
Identifier printed on the form (e.g. 'Part III'), if any
- `label: optional string`
Printed section heading, if any
- `type: optional "section"`
Form section node
- `"section"`
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
### Header Item
- `HeaderItem object { items, md, bbox, type }`
- `items: array of CodeItem or HeadingItem or ImageItem or 4 more`
List of items within the header
- `CodeItem object { md, value, bbox, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Code content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `language: optional string`
Programming language identifier
- `type: optional "code"`
Code block item type
- `"code"`
- `HeadingItem object { level, md, value, 2 more }`
- `level: number`
Heading level (1-6)
- `md: string`
Markdown representation preserving formatting
- `value: string`
Heading text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "heading"`
Heading item type
- `"heading"`
- `ImageItem object { caption, md, url, 2 more }`
- `caption: string`
Image caption
- `md: string`
Markdown representation preserving formatting
- `url: string`
URL to the image
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "image"`
Image item type
- `"image"`
- `LinkItem object { md, text, url, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `text: string`
Display text of the link
- `url: string`
URL of the link
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "link"`
Link item type
- `"link"`
- `ListItem object { items, md, ordered, 2 more }`
- `items: array of TextItem or ListItem`
List of nested text or list items
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "text"`
Text item type
- `"text"`
- `ListItem object { items, md, ordered, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `ordered: boolean`
Whether the list is ordered or unordered
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "list"`
List item type
- `"list"`
- `TableItem object { csv, html, md, 6 more }`
- `csv: string`
CSV representation of the table
- `html: string`
HTML representation of the table
- `md: string`
Markdown representation preserving formatting
- `rows: array of array of string or number`
Table data as array of arrays (string, number, or null)
- `string`
- `number`
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `merged_from_pages: optional array of number`
List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])
- `merged_into_page: optional number`
Populated when merged into another table. Page number where the full merged table begins (used on empty tables).
- `parse_concerns: optional array of object { details, type }`
Quality concerns detected during table extraction, indicating the table may have issues
- `details: string`
Human-readable details about the concern
- `type: string`
Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)
- `type: optional "table"`
Table item type
- `"table"`
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "header"`
Page header container
- `"header"`
### Heading Item
- `HeadingItem object { level, md, value, 2 more }`
- `level: number`
Heading level (1-6)
- `md: string`
Markdown representation preserving formatting
- `value: string`
Heading text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "heading"`
Heading item type
- `"heading"`
### Image Item
- `ImageItem object { caption, md, url, 2 more }`
- `caption: string`
Image caption
- `md: string`
Markdown representation preserving formatting
- `url: string`
URL to the image
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "image"`
Image item type
- `"image"`
### Link Item
- `LinkItem object { md, text, url, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `text: string`
Display text of the link
- `url: string`
URL of the link
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "link"`
Link item type
- `"link"`
### List Item
- `ListItem object { items, md, ordered, 2 more }`
- `items: array of TextItem or ListItem`
List of nested text or list items
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "text"`
Text item type
- `"text"`
- `ListItem object { items, md, ordered, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `ordered: boolean`
Whether the list is ordered or unordered
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "list"`
List item type
- `"list"`
### Llama Parse Supported File Extensions
- `LlamaParseSupportedFileExtensions = ".abw" or ".awt" or ".azw" or 144 more`
Enum for supported file extensions.
- `".abw"`
- `".awt"`
- `".azw"`
- `".azw3"`
- `".azw4"`
- `".bmp"`
- `".cb7"`
- `".cbc"`
- `".cbr"`
- `".cbz"`
- `".cgm"`
- `".chm"`
- `".csv"`
- `".cwk"`
- `".dbf"`
- `".dif"`
- `".djvu"`
- `".doc"`
- `".docm"`
- `".docx"`
- `".dot"`
- `".dotm"`
- `".dotx"`
- `".epub"`
- `".et"`
- `".eth"`
- `".fb2"`
- `".fbz"`
- `".fodg"`
- `".fodp"`
- `".fods"`
- `".fodt"`
- `".fopd"`
- `".gif"`
- `".heic"`
- `".heif"`
- `".htm"`
- `".html"`
- `".htmlz"`
- `".hwp"`
- `".jpeg"`
- `".jpg"`
- `".key"`
- `".lit"`
- `".lrf"`
- `".lwp"`
- `".m4a"`
- `".mcw"`
- `".md"`
- `".mobi"`
- `".mp3"`
- `".mp4"`
- `".mpeg"`
- `".mpga"`
- `".mw"`
- `".mwd"`
- `".numbers"`
- `".odf"`
- `".odg"`
- `".odp"`
- `".ods"`
- `".odt"`
- `".otg"`
- `".otp"`
- `".ots"`
- `".ott"`
- `".pages"`
- `".pbd"`
- `".pdb"`
- `".pdf"`
- `".pml"`
- `".png"`
- `".pot"`
- `".potm"`
- `".potx"`
- `".ppt"`
- `".pptm"`
- `".pptx"`
- `".prc"`
- `".prn"`
- `".psw"`
- `".qpw"`
- `".rb"`
- `".rtf"`
- `".sda"`
- `".sdd"`
- `".sdp"`
- `".sdw"`
- `".sgl"`
- `".slk"`
- `".snb"`
- `".stc"`
- `".std"`
- `".sti"`
- `".stw"`
- `".svg"`
- `".sxc"`
- `".sxd"`
- `".sxg"`
- `".sxi"`
- `".sxm"`
- `".sxw"`
- `".sylk"`
- `".tcr"`
- `".tif"`
- `".tiff"`
- `".tsv"`
- `".txtz"`
- `".uof"`
- `".uop"`
- `".uos"`
- `".uos1"`
- `".uos2"`
- `".uot"`
- `".vdx"`
- `".vor"`
- `".vsd"`
- `".vsdm"`
- `".vsdx"`
- `".wav"`
- `".wb1"`
- `".wb2"`
- `".wb3"`
- `".webm"`
- `".webp"`
- `".wk1"`
- `".wk2"`
- `".wk3"`
- `".wk4"`
- `".wks"`
- `".wn"`
- `".wpd"`
- `".wps"`
- `".wpt"`
- `".wq1"`
- `".wq2"`
- `".wri"`
- `".xhtm"`
- `".xlr"`
- `".xls"`
- `".xlsb"`
- `".xlsm"`
- `".xlsx"`
- `".xlw"`
- `".xml"`
- `".yxmd"`
- `".zabw"`
### Parsing Job
- `ParsingJob object { id, status, error_code, error_message }`
A parse job (v1).
- `id: string`
Unique parse job identifier
- `status: StatusEnum`
Current job status
- `"CANCELLED"`
- `"ERROR"`
- `"PARTIAL_SUCCESS"`
- `"PENDING"`
- `"SUCCESS"`
- `error_code: optional string`
Machine-readable error code when failed
- `error_message: optional string`
Human-readable error details when failed
### Parsing Languages
- `ParsingLanguages = "abq" or "ady" or "af" or 83 more`
Enum for representing the languages supported by the parser.
- `"abq"`
- `"ady"`
- `"af"`
- `"ang"`
- `"ar"`
- `"as"`
- `"ava"`
- `"az"`
- `"be"`
- `"bg"`
- `"bgc"`
- `"bh"`
- `"bho"`
- `"bn"`
- `"bs"`
- `"ch_sim"`
- `"ch_tra"`
- `"che"`
- `"cs"`
- `"cy"`
- `"da"`
- `"dar"`
- `"de"`
- `"en"`
- `"es"`
- `"et"`
- `"fa"`
- `"fr"`
- `"ga"`
- `"gom"`
- `"hi"`
- `"hr"`
- `"hu"`
- `"id"`
- `"inh"`
- `"is"`
- `"it"`
- `"ja"`
- `"kbd"`
- `"kn"`
- `"ko"`
- `"ku"`
- `"la"`
- `"lbe"`
- `"lez"`
- `"lt"`
- `"lv"`
- `"mah"`
- `"mai"`
- `"mi"`
- `"mn"`
- `"mni"`
- `"mr"`
- `"ms"`
- `"mt"`
- `"ne"`
- `"new"`
- `"nl"`
- `"no"`
- `"oc"`
- `"pi"`
- `"pl"`
- `"pt"`
- `"ro"`
- `"rs_cyrillic"`
- `"rs_latin"`
- `"ru"`
- `"sa"`
- `"sck"`
- `"sk"`
- `"sl"`
- `"sq"`
- `"sv"`
- `"sw"`
- `"ta"`
- `"tab"`
- `"te"`
- `"th"`
- `"tjk"`
- `"tl"`
- `"tr"`
- `"ug"`
- `"uk"`
- `"ur"`
- `"uz"`
- `"vi"`
### Parsing Mode
- `ParsingMode = "parse_document_with_agent" or "parse_document_with_llm" or "parse_document_with_lvm" or 5 more`
Enum for representing the mode of parsing to be used.
- `"parse_document_with_agent"`
- `"parse_document_with_llm"`
- `"parse_document_with_lvm"`
- `"parse_page_with_agent"`
- `"parse_page_with_layout_agent"`
- `"parse_page_with_llm"`
- `"parse_page_with_lvm"`
- `"parse_page_without_llm"`
### Status Enum
- `StatusEnum = "CANCELLED" or "ERROR" or "PARTIAL_SUCCESS" or 2 more`
Enum for representing the status of a job
- `"CANCELLED"`
- `"ERROR"`
- `"PARTIAL_SUCCESS"`
- `"PENDING"`
- `"SUCCESS"`
### Table Item
- `TableItem object { csv, html, md, 6 more }`
- `csv: string`
CSV representation of the table
- `html: string`
HTML representation of the table
- `md: string`
Markdown representation preserving formatting
- `rows: array of array of string or number`
Table data as array of arrays (string, number, or null)
- `string`
- `number`
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `merged_from_pages: optional array of number`
List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])
- `merged_into_page: optional number`
Populated when merged into another table. Page number where the full merged table begins (used on empty tables).
- `parse_concerns: optional array of object { details, type }`
Quality concerns detected during table extraction, indicating the table may have issues
- `details: string`
Human-readable details about the concern
- `type: string`
Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)
- `type: optional "table"`
Table item type
- `"table"`
### Text Item
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "text"`
Text item type
- `"text"`
### Parsing Create Response
- `ParsingCreateResponse object { id, project_id, status, 6 more }`
A parse job.
- `id: string`
Unique parse job identifier
- `project_id: string`
Project this job belongs to
- `status: "CANCELLED" or "COMPLETED" or "FAILED" or 2 more`
Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
- `"CANCELLED"`
- `"COMPLETED"`
- `"FAILED"`
- `"PENDING"`
- `"RUNNING"`
- `created_at: optional string`
Creation datetime
- `error_message: optional string`
Error details when status is FAILED
- `name: optional string`
Optional display name for this parse job
- `tier: optional string`
Parsing tier used for this job
- `updated_at: optional string`
Update datetime
- `user_metadata: optional map[string]`
Key/value tags associated with this job.
### Parsing Get Response
- `ParsingGetResponse object { job, forms, images_content_metadata, 9 more }`
Parse result response with job status and optional content or metadata.
The job field is always included. Other fields are included based on expand parameters.
- `job: object { id, project_id, status, 6 more }`
Parse job status and metadata
- `id: string`
Unique parse job identifier
- `project_id: string`
Project this job belongs to
- `status: "CANCELLED" or "COMPLETED" or "FAILED" or 2 more`
Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
- `"CANCELLED"`
- `"COMPLETED"`
- `"FAILED"`
- `"PENDING"`
- `"RUNNING"`
- `created_at: optional string`
Creation datetime
- `error_message: optional string`
Error details when status is FAILED
- `name: optional string`
Optional display name for this parse job
- `tier: optional string`
Parsing tier used for this job
- `updated_at: optional string`
Update datetime
- `user_metadata: optional map[string]`
Key/value tags associated with this job.
- `forms: optional object { pages }`
Per-page form analysis results (one entry per page).
- `pages: array of object { forms, page_number, success } or object { error, page_number, success }`
List of form pages or failed page entries
- `FormsResultPage object { forms, page_number, success }`
Forms found on one page. Pages without form content have an empty forms list.
- `forms: array of Form`
Forms detected on the page
- `json: array of FormField or FormSection or FormTable`
Structured representation: an ordered tree of sections, fields, and tables
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `field: "checkbox" or "multi_select" or "signature" or 2 more`
Kind of entry: text (any free-text input), checkbox, single_select, multi_select, or signature
- `"checkbox"`
- `"multi_select"`
- `"signature"`
- `"single_select"`
- `"text"`
- `id: optional string`
Field number/letter printed on the form (e.g. '1a'), if any
- `isEmpty: optional boolean`
True for a printed-but-blank text field (mutually exclusive with value)
- `label: optional string`
Printed field caption, if any
- `type: optional "field"`
Form field node
- `"field"`
- `value: optional string or boolean`
Entered content: verbatim text for text fields, or a boolean for checkbox (checked) and signature (signed). Absent on blank text fields and on select groups
- `string`
- `boolean`
- `valueItems: optional array of FormField or FormSection or FormTable`
Options of a single_select/multi_select group (only on select fields)
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `items: array of FormField or FormSection or FormTable`
Child form nodes in reading order
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `rows: array of array of string or FormTableCellItems`
Table cells: a verbatim string, null for a printed-but-blank cell, or an object holding the cell's own form nodes
- `string`
- `FormTableCellItems object { items }`
A table cell holding its own form nodes (e.g. a checkbox column).
- `items: array of FormField or FormSection or FormTable`
Form nodes inside the cell
- `FormField object { field, id, isEmpty, 4 more }`
One labeled form entry: a text input, checkbox, select group, or signature line.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `id: optional string`
Identifier printed on the form, if any
- `columns: optional array of string`
Printed column headers in order, if any
- `label: optional string`
Printed table caption, if any
- `type: optional "table"`
Form table node
- `"table"`
- `id: optional string`
Identifier printed on the form (e.g. 'Part III'), if any
- `label: optional string`
Printed section heading, if any
- `type: optional "section"`
Form section node
- `"section"`
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `FormSection object { items, id, label, type }`
A grouping of form content, in the form's reading order.
- `FormTable object { rows, id, columns, 2 more }`
A fillable grid printed on the form: repeating records or a row-by-column matrix.
- `list: FormListItem`
Flattened list representation of the same content
- `items: array of FormListTextItem or FormListItem`
Nested lines and sub-lists, in the form's reading order
- `FormListTextItem object { md, value, type }`
One line of a form's list representation.
- `md: string`
Markdown representation of the line
- `value: string`
Line content (e.g. '[1a] Wages: 29,513')
- `type: optional "text"`
Text line
- `"text"`
- `FormListItem object { items, md, ordered, type }`
The list representation of form content: nested lists of rendered field lines.
- `md: string`
Markdown representation of this list
- `ordered: boolean`
Whether the list is ordered
- `type: optional "list"`
List node
- `"list"`
- `page_number: number`
Page number of the document
- `success: true`
Success indicator
- `true`
- `FailedFormsPage object { error, page_number, success }`
A page whose processing failed.
- `error: string`
Error message describing the failure
- `page_number: number`
Page number of the document
- `success: false`
Failure indicator
- `false`
- `images_content_metadata: optional object { images, total_count }`
Metadata for all extracted images.
- `images: array of object { filename, index, bbox, 4 more }`
List of image metadata with presigned URLs
- `filename: string`
Image filename (e.g., 'image_0.png')
- `index: number`
Index of the image in the extraction order
- `bbox: optional object { h, w, x, y }`
Bounding box for an image on its page.
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `category: optional "embedded" or "layout" or "screenshot"`
Image category: 'screenshot' (full page), 'embedded' (images in document), or 'layout' (cropped from layout detection)
- `"embedded"`
- `"layout"`
- `"screenshot"`
- `content_type: optional string`
MIME type of the image
- `presigned_url: optional string`
Presigned URL to download the image
- `size_bytes: optional number`
Deprecated: always returns None. Will be removed in a future release.
- `total_count: number`
Total number of extracted images
- `items: optional object { pages }`
Structured JSON result (if requested)
- `pages: array of object { items, page_height, page_number, 2 more } or object { error, page_number, success }`
List of structured pages or failed page entries
- `StructuredResultPage object { items, page_height, page_number, 2 more }`
- `items: array of CodeItem or FooterItem or HeaderItem or 6 more`
List of structured items on the page
- `CodeItem object { md, value, bbox, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Code content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `language: optional string`
Programming language identifier
- `type: optional "code"`
Code block item type
- `"code"`
- `FooterItem object { items, md, bbox, type }`
- `items: array of CodeItem or HeadingItem or ImageItem or 4 more`
List of items within the footer
- `CodeItem object { md, value, bbox, 2 more }`
- `HeadingItem object { level, md, value, 2 more }`
- `level: number`
Heading level (1-6)
- `md: string`
Markdown representation preserving formatting
- `value: string`
Heading text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "heading"`
Heading item type
- `"heading"`
- `ImageItem object { caption, md, url, 2 more }`
- `caption: string`
Image caption
- `md: string`
Markdown representation preserving formatting
- `url: string`
URL to the image
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "image"`
Image item type
- `"image"`
- `LinkItem object { md, text, url, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `text: string`
Display text of the link
- `url: string`
URL of the link
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "link"`
Link item type
- `"link"`
- `ListItem object { items, md, ordered, 2 more }`
- `items: array of TextItem or ListItem`
List of nested text or list items
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `value: string`
Text content
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "text"`
Text item type
- `"text"`
- `ListItem object { items, md, ordered, 2 more }`
- `md: string`
Markdown representation preserving formatting
- `ordered: boolean`
Whether the list is ordered or unordered
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "list"`
List item type
- `"list"`
- `TableItem object { csv, html, md, 6 more }`
- `csv: string`
CSV representation of the table
- `html: string`
HTML representation of the table
- `md: string`
Markdown representation preserving formatting
- `rows: array of array of string or number`
Table data as array of arrays (string, number, or null)
- `string`
- `number`
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `merged_from_pages: optional array of number`
List of page numbers with tables that were merged into this table (e.g., [1, 2, 3, 4])
- `merged_into_page: optional number`
Populated when merged into another table. Page number where the full merged table begins (used on empty tables).
- `parse_concerns: optional array of object { details, type }`
Quality concerns detected during table extraction, indicating the table may have issues
- `details: string`
Human-readable details about the concern
- `type: string`
Type of parse concern (e.g. header_value_type_mismatch, inconsistent_row_cell_count)
- `type: optional "table"`
Table item type
- `"table"`
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "footer"`
Page footer container
- `"footer"`
- `HeaderItem object { items, md, bbox, type }`
- `items: array of CodeItem or HeadingItem or ImageItem or 4 more`
List of items within the header
- `CodeItem object { md, value, bbox, 2 more }`
- `HeadingItem object { level, md, value, 2 more }`
- `ImageItem object { caption, md, url, 2 more }`
- `LinkItem object { md, text, url, 2 more }`
- `ListItem object { items, md, ordered, 2 more }`
- `TableItem object { csv, html, md, 6 more }`
- `TextItem object { md, value, bbox, type }`
- `md: string`
Markdown representation preserving formatting
- `bbox: optional array of BBox`
List of bounding boxes
- `h: number`
Height of the bounding box
- `w: number`
Width of the bounding box
- `x: number`
X coordinate of the bounding box
- `y: number`
Y coordinate of the bounding box
- `confidence: optional number`
Confidence score
- `end_index: optional number`
End index in the text
- `label: optional string`
Label for the bounding box
- `r: optional number`
Optional visual text rotation angle in degrees. Omitted when unrotated.
- `start_index: optional number`
Start index in the text
- `type: optional "header"`
Page header container
- `"header"`
- `HeadingItem object { level, md, value, 2 more }`
- `ImageItem object { caption, md, url, 2 more }`
- `LinkItem object { md, text, url, 2 more }`
- `ListItem object { items, md, ordered, 2 more }`
- `TableItem object { csv, html, md, 6 more }`
- `TextItem object { md, value, bbox, type }`
- `page_height: number`
Height of the page in points
- `page_number: number`
Page number of the document
- `page_width: number`
Width of the page in points
- `success: true`
Success indicator
- `true`
- `FailedStructuredPage object { error, page_number, success }`
- `error: string`
Error message describing the failure
- `page_number: number`
Page number of the document
- `success: false`
Failure indicator
- `false`
- `job_metadata: optional map[unknown]`
Job execution metadata (if requested)
- `markdown: optional object { pages }`
Markdown result (if requested)
- `pages: array of object { markdown, page_number, success, 2 more } or object { error, page_number, success }`
List of markdown pages or failed page entries
- `MarkdownResultPage object { markdown, page_number, success, 2 more }`
- `markdown: string`
Markdown content of the page
- `page_number: number`
Page number of the document
- `success: true`
Success indicator
- `true`
- `footer: optional string`
Footer of the page in markdown
- `header: optional string`
Header of the page in markdown
- `FailedMarkdownPage object { error, page_number, success }`
- `error: string`
Error message describing the failure
- `page_number: number`
Page number of the document
- `success: false`
Failure indicator
- `false`
- `markdown_full: optional string`
Full raw markdown content (if requested)
- `metadata: optional object { pages }`
Result containing metadata (page level and general) for the parsed document.
- `pages: array of object { page_number, confidence, cost_optimized, 5 more }`
List of page metadata entries
- `page_number: number`
Page number of the document
- `confidence: optional number`
Confidence score for the page parsing (0-1)
- `cost_optimized: optional boolean`
Whether cost-optimized parsing was used for the page
- `original_orientation_angle: optional number`
Original orientation angle of the page in degrees
- `printed_page_number: optional string`
Printed page number as it appears in the document
- `slide_section_name: optional string`
Section name from presentation slides
- `speaker_notes: optional string`
Speaker notes from presentation slides
- `triggered_auto_mode: optional boolean`
Whether auto mode was triggered for the page
- `raw_parameters: optional map[unknown]`
- `result_content_metadata: optional map[object { size_bytes, exists, presigned_url } ]`
Metadata including size, existence, and presigned URLs for result files
- `size_bytes: number`
Size of the result file in bytes
- `exists: optional boolean`
Whether the result file exists in S3
- `presigned_url: optional string`
Presigned URL to download the result file
- `text: optional object { pages }`
Plain text result (if requested)
- `pages: array of object { page_number, text }`
List of text pages
- `page_number: number`
Page number of the document
- `text: string`
Plain text content of the page
- `text_full: optional string`
Full raw text content (if requested)
### Parsing List Response
- `ParsingListResponse object { id, project_id, status, 6 more }`
A parse job.
- `id: string`
Unique parse job identifier
- `project_id: string`
Project this job belongs to
- `status: "CANCELLED" or "COMPLETED" or "FAILED" or 2 more`
Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
- `"CANCELLED"`
- `"COMPLETED"`
- `"FAILED"`
- `"PENDING"`
- `"RUNNING"`
- `created_at: optional string`
Creation datetime
- `error_message: optional string`
Error details when status is FAILED
- `name: optional string`
Optional display name for this parse job
- `tier: optional string`
Parsing tier used for this job
- `updated_at: optional string`
Update datetime
- `user_metadata: optional map[string]`
Key/value tags associated with this job.