LlamaParse Configurations API
The Configurations API from LlamaParse — 2 operation(s) for configurations.
The Configurations API from LlamaParse — 2 operation(s) for configurations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/llamaparse-configurations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Llama Platform Agent Data Configurations API
version: 0.1.0
servers:
- url: https://api.cloud.llamaindex.ai
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Configurations
paths:
/api/v1/beta/configurations:
post:
tags:
- Configurations
summary: Create Configuration
description: Upsert a product configuration; updates if one with the same name + product type + project exists, otherwise creates.
operationId: create_configuration_api_v1_beta_configurations_post
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationCreateRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Configurations
summary: List Configurations
description: List product configurations for the current project.
operationId: list_configurations_api_v1_beta_configurations_get
security:
- HTTPBearer: []
parameters:
- name: product_type
in: query
required: false
schema:
anyOf:
- type: array
items:
enum:
- split_v1
- extract_v2
- classify_v2
- parse_v2
- spreadsheet_v1
- unknown
type: string
- type: 'null'
description: Filter by one or more product types. Repeat the parameter for multiple values.
title: Product Type
description: Filter by one or more product types. Repeat the parameter for multiple values.
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by configuration name.
title: Name
description: Filter by configuration name.
- name: page_size
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Number of items per page.
title: Page Size
description: Number of items per page.
- name: page_token
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Pagination token.
title: Page Token
description: Pagination token.
- name: latest_only
in: query
required: false
schema:
type: boolean
description: Return only the latest version per configuration name.
default: false
title: Latest Only
description: Return only the latest version per configuration name.
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationQueryResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/beta/configurations/{config_id}:
get:
tags:
- Configurations
summary: Get Configuration
description: Get a single product configuration by ID.
operationId: get_configuration_api_v1_beta_configurations__config_id__get
security:
- HTTPBearer: []
parameters:
- name: config_id
in: path
required: true
schema:
type: string
title: Config Id
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Configurations
summary: Update Configuration
description: Update an existing product configuration.
operationId: update_configuration_api_v1_beta_configurations__config_id__put
security:
- HTTPBearer: []
parameters:
- name: config_id
in: path
required: true
schema:
type: string
title: Config Id
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationUpdateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Configurations
summary: Delete Configuration
description: Delete a product configuration.
operationId: delete_configuration_api_v1_beta_configurations__config_id__delete
security:
- HTTPBearer: []
parameters:
- name: config_id
in: path
required: true
schema:
type: string
title: Config Id
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
LlamaParseWebhookConfiguration:
properties:
webhook_url:
anyOf:
- type: string
pattern: '^https?:'
- type: 'null'
title: Webhook Url
description: HTTPS URL to receive webhook POST requests. Must be publicly accessible
webhook_headers:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Webhook Headers
description: 'Custom HTTP headers to include in webhook requests. Use for authentication tokens or custom routing. Example: {''Authorization'': ''Bearer xyz''}'
webhook_events:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Webhook Events
description: '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'
examples:
- - parse.success
- parse.error
webhook_output_format:
anyOf:
- type: string
enum:
- string
- json
- type: 'null'
title: Webhook Output Format
description: Format of the webhook payload body. 'string' (default) sends the payload as a JSON-encoded string; 'json' sends it as a JSON object.
examples:
- json
additionalProperties: false
type: object
title: LlamaParseWebhookConfiguration
description: 'Webhook configuration for receiving parsing job notifications.
Webhooks are called when specified events occur during job processing.
Configure multiple webhook configurations to send to different endpoints.'
SplitCategory:
properties:
name:
type: string
maxLength: 200
minLength: 1
title: Name
description: Name of the category.
description:
anyOf:
- type: string
maxLength: 2000
minLength: 1
- type: 'null'
title: Description
description: Optional description of what content belongs in this category.
type: object
required:
- name
title: SplitCategory
description: Category definition for document splitting.
ExtractV2Parameters:
properties:
target_pages:
anyOf:
- type: string
- type: 'null'
title: Target Pages
description: Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
examples:
- 1,3,5-7
- 1-3,8-10
max_pages:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Max Pages
description: Maximum number of pages to process. Omit for no limit.
examples:
- 10
tier:
type: string
enum:
- cost_effective
- agentic
title: Tier
description: 'Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page)'
default: cost_effective
examples:
- cost_effective
- agentic
version:
type: string
title: Version
description: Use 'latest' for the latest release for the selected tier or a date string (YYYY-MM-DD format) to pin to the nearest release at or before that date.
default: latest
examples:
- latest
data_schema:
additionalProperties:
anyOf:
- additionalProperties: true
type: object
- items: {}
type: array
- type: string
- type: integer
- type: number
- type: boolean
- type: 'null'
type: object
title: Data Schema
description: JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first.
extraction_target:
type: string
enum:
- per_doc
- per_page
- per_table_row
title: Extraction Target
description: 'Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row'
default: per_doc
examples:
- per_doc
- per_page
- per_table_row
system_prompt:
anyOf:
- type: string
- type: 'null'
title: System Prompt
description: Custom system prompt to guide extraction behavior
examples:
- Extract all monetary values in USD. If a currency is not specified, assume USD.
cite_sources:
type: boolean
title: Cite Sources
description: Include citations in results
default: false
confidence_scores:
type: boolean
title: Confidence Scores
description: Include confidence scores in results
default: false
parse_tier:
anyOf:
- type: string
- type: 'null'
title: Parse Tier
description: Parse tier to use before extraction. Defaults to the extract tier if not specified.
examples:
- fast
- cost_effective
parse_config_id:
anyOf:
- type: string
- type: 'null'
title: Parse Config Id
description: Saved parse configuration ID to control how the document is parsed before extraction
examples:
- cfg-11111111-2222-3333-4444-555555555555
product_type:
type: string
const: extract_v2
title: Product Type
description: Product type.
type: object
required:
- data_schema
- product_type
title: ExtractV2Parameters
description: Typed parameters for an *extract v2* product configuration.
UntypedParameters:
properties:
product_type:
type: string
const: unknown
title: Product Type
description: Product type.
additionalProperties: true
type: object
required:
- product_type
title: UntypedParameters
description: 'Catch-all for configurations without a dedicated typed schema.
Accepts arbitrary JSON fields alongside ``product_type``.'
SplitV1Parameters:
properties:
categories:
items:
$ref: '#/components/schemas/SplitCategory'
type: array
maxItems: 50
minItems: 1
title: Categories
description: Categories to split documents into.
splitting_strategy:
$ref: '#/components/schemas/SplitStrategy'
description: Strategy for splitting documents.
product_type:
type: string
const: split_v1
title: Product Type
description: Product type.
type: object
required:
- categories
- product_type
title: SplitV1Parameters
description: Typed parameters for a *split v1* product configuration.
LlamaParseTables:
properties:
compact_markdown_tables:
anyOf:
- type: boolean
- type: 'null'
title: Compact Markdown Tables
description: Remove extra whitespace padding in markdown table cells for more compact output
output_tables_as_markdown:
anyOf:
- type: boolean
- type: 'null'
title: Output Tables As Markdown
description: Output tables as markdown pipe tables instead of HTML <table> tags. Markdown tables are simpler but cannot represent complex structures like merged cells
markdown_table_multiline_separator:
anyOf:
- type: string
- type: 'null'
title: Markdown Table Multiline Separator
description: 'Separator string for multiline cell content in markdown tables. Example: ''<br>'' to preserve line breaks, '' '' to join with spaces'
merge_continued_tables:
anyOf:
- type: boolean
- type: 'null'
title: Merge Continued Tables
description: Automatically merge tables that span multiple pages into a single table. The merged table appears on the first page with merged_from_pages metadata
additionalProperties: false
type: object
title: LlamaParseTables
description: Table formatting options for markdown output.
LlamaParseOutputOptions:
properties:
markdown:
$ref: '#/components/schemas/LlamaParseMarkdownOptions'
description: Markdown formatting options including table styles and link annotations
spatial_text:
$ref: '#/components/schemas/LlamaParseSpatialTextOptions'
description: Spatial text output options for preserving document layout structure
tables_as_spreadsheet:
$ref: '#/components/schemas/LlamaParseTablesAsSpreadsheetOptions'
description: Options for exporting tables as XLSX spreadsheets
extract_printed_page_number:
anyOf:
- type: boolean
- type: 'null'
title: Extract Printed Page Number
description: Extract the printed page number as it appears in the document (e.g., 'Page 5 of 10', 'v', 'A-3'). Useful for referencing original page numbers
images_to_save:
items:
type: string
enum:
- screenshot
- embedded
- layout
type: array
title: Images To Save
description: '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'
additional_outputs:
items:
type: string
type: array
title: Additional Outputs
description: '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`.'
examples:
- - stripped_md
- concatenated_stripped_txt
- word_bbox
granular_bboxes:
items:
type: string
enum:
- cell
- line
- word
type: array
title: Granular Bboxes
description: 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.
examples:
- - word
- line
- cell
additionalProperties: false
type: object
title: LlamaParseOutputOptions
description: 'Output formatting and content extraction options.
Controls how parsed content is formatted and what additional data is extracted.'
AutoModeIgnoreOptions:
properties:
ignore_diagonal_text:
anyOf:
- type: boolean
- type: 'null'
title: Ignore Diagonal Text
description: Whether to ignore diagonal text in the document
ignore_hidden_text:
anyOf:
- type: boolean
- type: 'null'
title: Ignore Hidden Text
description: Whether to ignore hidden text in the document
additionalProperties: false
type: object
title: AutoModeIgnoreOptions
description: Ignore options for auto mode parsing configuration.
LlamaParseHtmlOptions:
properties:
make_all_elements_visible:
anyOf:
- type: boolean
- type: 'null'
title: Make All Elements Visible
description: 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:
anyOf:
- type: boolean
- type: 'null'
title: Remove Fixed Elements
description: Remove fixed-position elements (headers, footers, floating buttons) that appear on every page render
remove_navigation_elements:
anyOf:
- type: boolean
- type: 'null'
title: Remove Navigation Elements
description: Remove navigation elements (nav bars, sidebars, menus) to focus on main content
additionalProperties: false
type: object
title: LlamaParseHtmlOptions
description: HTML/web page parsing options.
LlamaParseProcessingOptions:
properties:
ignore:
$ref: '#/components/schemas/LlamaParseIgnoreOptions'
description: Options for ignoring specific text types (diagonal, hidden, text in images)
ocr_parameters:
$ref: '#/components/schemas/LlamaParseOcrParameters'
description: OCR configuration including language detection settings
aggressive_table_extraction:
anyOf:
- type: boolean
- type: 'null'
title: Aggressive Table Extraction
description: Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables
disable_heuristics:
anyOf:
- type: boolean
- type: 'null'
title: Disable Heuristics
description: Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results
specialized_chart_parsing:
anyOf:
- type: string
enum:
- agentic_plus
- agentic
- efficient
- type: 'null'
title: Specialized Chart Parsing
description: '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'
cost_optimizer:
anyOf:
- $ref: '#/components/schemas/LlamaParseCostOptimizerParameters'
- type: 'null'
description: Cost optimization settings. Only available with 'agentic' or 'agentic_plus' tiers
auto_mode_configuration:
anyOf:
- items:
$ref: '#/components/schemas/AutoModeConfigurationEntry'
type: array
- type: 'null'
title: Auto Mode Configuration
description: 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
additionalProperties: false
type: object
title: LlamaParseProcessingOptions
description: 'Processing options shared across all parsing tiers.
These options control how documents are analyzed and processed regardless of the selected tier.
Some options automatically enable additional behaviors (e.g., specialized_chart_parsing
enables extract_layout and precise_bounding_box).'
LlamaParseCropBox:
properties:
bottom:
anyOf:
- type: number
maximum: 1.0
minimum: 0.0
- type: 'null'
title: Bottom
description: Bottom boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content below this line is excluded
left:
anyOf:
- type: number
maximum: 1.0
minimum: 0.0
- type: 'null'
title: Left
description: Left boundary as ratio (0-1). 0=left edge, 1=right edge. Content left of this line is excluded
right:
anyOf:
- type: number
maximum: 1.0
minimum: 0.0
- type: 'null'
title: Right
description: Right boundary as ratio (0-1). 0=left edge, 1=right edge. Content right of this line is excluded
top:
anyOf:
- type: number
maximum: 1.0
minimum: 0.0
- type: 'null'
title: Top
description: Top boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content above this line is excluded
additionalProperties: false
type: object
title: LlamaParseCropBox
description: 'Crop box boundaries for processing only a portion of each page.
All values are ratios from 0 to 1, where (0,0) is the top-left corner and (1,1) is
the bottom-right corner. For example, to process only the top half of each page,
set bottom=0.5 (keeping top=0, left=0, right=1).'
ClassifyV2ParsingConfiguration:
properties:
lang:
type: string
title: Lang
description: ISO 639-1 language code for the document
default: en
examples:
- en
- es
- zh
target_pages:
anyOf:
- type: string
- type: 'null'
title: Target Pages
description: Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.
examples:
- 1,3,5-7
- 1-3,8-10
max_pages:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Max Pages
description: Maximum number of pages to process. Omit for no limit.
examples:
- 10
type: object
title: ClassifyV2ParsingConfiguration
description: Parsing configuration for classify jobs.
ClassifyV2Rule:
properties:
type:
type: string
maxLength: 50
minLength: 1
title: Type
description: Document type to assign when rule matches
examples:
- invoice
- receipt
- contract
- report
- proposal
description:
type: string
maxLength: 500
minLength: 10
title: Description
description: Natural language criteria for matching this rule
examples:
- contains invoice number, line items, and total amount
- purchase receipt with transaction info and merchant details
- legal contract with terms, conditions, and signatures
type: object
required:
- type
- description
title: ClassifyV2Rule
description: A rule for classifying documents.
LlamaParseCostOptimizerParameters:
properties:
enable:
anyOf:
- type: boolean
- type: 'null'
title: Enable
description: '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'
additionalProperties: false
type: object
title: LlamaParseCostOptimizerParameters
description: '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.'
LlamaParseInputOptions:
properties:
html:
$ref: '#/components/schemas/LlamaParseHtmlOptions'
description: HTML/web page parsing options (applies to .html, .htm files)
pdf:
$ref: '#/components/schemas/LlamaParsePdfOptions'
description: PDF-specific parsing options (applies to .pdf files)
spreadsheet:
$ref: '#/components/schemas/LlamaParseSpreadsheetOptions'
description: Spreadsheet parsing options (applies to .xlsx, .xls, .csv, .ods files)
presentation:
$ref: '#/components/schemas/LlamaParsePresentationOptions'
description: Presentation parsing options (applies to .pptx, .ppt, .odp, .key files)
additionalProperties: false
type: object
title: LlamaParseInputOptions
description: 'Input format-specific parsing options.
These options only apply when parsing documents of the corresponding format.
LlamaParse automatically detects the input format based on file extension and content.'
LlamaParseSpatialTextOptions:
properties:
preserve_layout_alignment_across_pages:
anyOf:
- type: boolean
- type: 'null'
title: Preserve Layout Alignment Across Pages
description: Maintain consistent text column alignment across page boundaries. Automatically enabled for document-level parsing modes
preserve_very_small_text:
anyOf:
- type: boolean
- type: 'null'
title: Preserve Very Small Text
description: Include text below the normal size threshold. Useful for footnotes, watermarks, or fine print that might otherwise be filtered out
do_not_unroll_columns:
anyOf:
- type: boolean
- type: 'null'
title: Do Not Unroll Columns
description: Keep multi-column layouts intact instead of linearizing columns into sequential text. Automatically enabled for non-fast tiers
additionalProperties: false
type: object
title: LlamaParseSpatialTextOptions
description: 'Spatial text output options for preserving document layout.
Spatial text maintains the visual positioning of text elements, useful for
documents where layout conveys meaning (forms, tables, multi-column layouts).'
AutoModeParsingConf:
properties:
tier:
anyOf:
- type: string
enum:
- fast
- cost_effective
- agentic
- agentic_plus
- type: 'null'
title: Tier
description:
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/llamaparse/refs/heads/main/openapi/llamaparse-configurations-api-openapi.yml