LlamaParse Configurations API
The Configurations API from LlamaParse — 2 operation(s) for configurations.
The Configurations API from LlamaParse — 2 operation(s) for configurations.
openapi: 3.0.3
info:
title: Llama Platform Agent Data Configurations API
version: 0.1.0
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:
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.
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.
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.
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``.'
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).'
LlamaParseProcessingControl:
properties:
timeouts:
$ref: '#/components/schemas/LlamaParseTimeouts'
description: Timeout settings for job execution. Increase for large or complex documents
job_failure_conditions:
$ref: '#/components/schemas/LlamaParseJobFailureConditions'
description: Quality thresholds that determine when a job should fail vs complete with partial results
additionalProperties: false
type: object
title: LlamaParseProcessingControl
description: Job processing controls for timeouts and failure handling.
LlamaParseFastOptions:
properties: {}
additionalProperties: false
type: object
title: LlamaParseFastOptions
description: '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.'
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.'
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
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.
LlamaParsePresentationOptions:
properties:
out_of_bounds_content:
anyOf:
- type: boolean
- type: 'null'
title: Out Of Bounds Content
description: Extract content positioned outside the visible slide area. Some presentations have hidden notes or content that extends beyond slide boundaries
skip_embedded_data:
anyOf:
- type: boolean
- type: 'null'
title: Skip Embedded Data
description: Skip extraction of embedded chart data tables. When true, only the visual representation of charts is captured, not the underlying data
additionalProperties: false
type: object
title: LlamaParsePresentationOptions
description: Presentation (PowerPoint, Keynote, ODP) parsing options.
LlamaParseJobFailureConditions:
properties:
allowed_page_failure_ratio:
anyOf:
- type: number
maximum: 1.0
exclusiveMinimum: 0.0
- type: 'null'
title: Allowed Page Failure Ratio
description: '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_image_extraction_error:
anyOf:
- type: boolean
- type: 'null'
title: Fail On Image Extraction Error
description: 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:
anyOf:
- type: boolean
- type: 'null'
title: Fail On Image Ocr Error
description: 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:
anyOf:
- type: boolean
- type: 'null'
title: Fail On Markdown Reconstruction Error
description: Fail the entire job if markdown cannot be reconstructed for any page. By default, failed pages use fallback text extraction
fail_on_buggy_font:
anyOf:
- type: boolean
- type: 'null'
title: Fail On Buggy Font
description: Fail the job if a problematic font is detected that may cause incorrect text extraction. Buggy fonts can produce garbled or missing characters
additionalProperties: false
type: object
title: LlamaParseJobFailureConditions
description: 'Conditions that determine when a parsing job should fail vs complete with partial results.
By default, jobs complete successfully even if some pages fail to parse.
Use these settings to enforce stricter quality requirements.'
ConfigurationResponse:
properties:
id:
type: string
title: Id
description: Unique configuration ID.
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Creation timestamp.
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Last update timestamp.
name:
type: string
title: Name
description: Configuration name.
product_type:
type: string
enum:
- split_v1
- extract_v2
- classify_v2
- parse_v2
- spreadsheet_v1
- unknown
title: Product Type
description: Product type.
version:
type: string
title: Version
description: Version identifier (datetime string).
parameters:
oneOf:
- $ref: '#/components/schemas/SplitV1Parameters'
- $ref: '#/components/schemas/ExtractV2Parameters'
- $ref: '#/components/schemas/ClassifyV2Parameters'
- $ref: '#/components/schemas/ParseV2Parameters'
- $ref: '#/components/schemas/SpreadsheetV1Parameters'
- $ref: '#/components/schemas/UntypedParameters'
title: Parameters
description: Product-specific configuration parameters.
discriminator:
propertyName: product_type
mapping:
classify_v2: '#/components/schemas/ClassifyV2Parameters'
extract_v2: '#/components/schemas/ExtractV2Parameters'
parse_v2: '#/components/schemas/ParseV2Parameters'
split_v1: '#/components/schemas/SplitV1Parameters'
spreadsheet_v1: '#/components/schemas/SpreadsheetV1Parameters'
unknown: '#/components/schemas/UntypedParameters'
type: object
required:
- id
- name
- product_type
- version
- parameters
title: ConfigurationResponse
description: Response schema for a single product configuration.
LlamaParseOcrParameters:
properties:
languages:
anyOf:
- items:
$ref: '#/components/schemas/ParserLanguages'
type: array
- type: 'null'
title: Languages
description: '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'
additionalProperties: false
type: object
title: LlamaParseOcrParameters
description: OCR (Optical Character Recognition) configuration parameters.
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.
AutoModePresentationOptions:
properties:
out_of_bounds_content:
anyOf:
- type: boolean
- type: 'null'
title: Out Of Bounds Content
description: Extract out of bounds content in presentation slides
skip_embedded_data:
anyOf:
- type: boolean
- type: 'null'
title: Skip Embedded Data
description: Skip extraction of embedded data for charts in presentation slides
additionalProperties: false
type: object
title: AutoModePresentationOptions
description: Presentation-specific options for auto mode parsing configuration.
AutoModeCropBox:
properties:
bottom:
anyOf:
- type: number
maximum: 1.0
minimum: 0.0
- type: 'null'
title: Bottom
description: Bottom boundary of crop box as ratio (0-1)
left:
anyOf:
- type: number
maximum: 1.0
minimum: 0.0
- type: 'null'
title: Left
description: Left boundary of crop box as ratio (0-1)
right:
anyOf:
- type: number
maximum: 1.0
minimum: 0.0
- type: 'null'
title: Right
description: Right boundary of crop box as ratio (0-1)
top:
anyOf:
- type: number
maximum: 1.0
minimum: 0.0
- type: 'null'
title: Top
description: Top boundary of crop box as ratio (0-1)
additionalProperties: false
type: object
title: AutoModeCropBox
description: Crop box options for auto mode parsing configuration.
LlamaParseTablesAsSpreadsheetOptions:
properties:
enable:
anyOf:
- type: boolean
- type: 'null'
title: Enable
description: Whether this option is enabled
guess_sheet_name:
type: boolean
title: Guess Sheet Name
description: Automatically generate descriptive sheet names from table context (headers, surrounding text) instead of using generic names like 'Table_1'
default: true
additionalProperties: false
type: object
title: LlamaParseTablesAsSpreadsheetOptions
description: Options for exporting extracted tables as XLSX spreadsheet files.
ClassifyV2Parameters:
properties:
rules:
items:
$ref: '#/components/schemas/ClassifyV2Rule'
type: array
minItems: 1
title: Rules
description: Classify rules to evaluate against the document (at least one required)
mode:
type: string
const: FAST
title: Mode
description: Classify execution mode
default: FAST
parsing_configuration:
anyOf:
- $ref: '#/components/schemas/ClassifyV2ParsingConfiguration'
- type: 'null'
description: Parsing configuration for controlling which pages are read
product_type:
type: string
const: classify_v2
title: Product Type
description: Product type.
type: object
required:
- rules
- product_type
title: ClassifyV2Parameters
description: Typed parameters for a *classify v2* product configuration.
AutoModeParsingConf:
properties:
tier:
anyOf:
- type: string
enum:
- fast
- cost_effective
- agentic
- agentic_plus
- type: 'null'
title: Tier
description: Override the parsing tier for matched pages. Must be paired with version
version:
anyOf:
- type: string
enum:
- latest
- '2026-06-05'
- '2026-06-04'
- '2025-12-11'
x-enum-order-preserved: true
- type: string
- type: 'null'
title: Version
description: '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`: `2025-12-11`
- `cost_effective`: `2026-06-05`
- `agentic`: `2026-06-04`
- `agentic_plus`: `2026-06-04`
Full list: `GET /api/v2/parse/versions`.'
custom_prompt:
anyOf:
- type: string
- type: 'null'
title: Custom Prompt
description: Custom AI instructions for matched pages. Overrides the base custom_prompt
ignore:
anyOf:
- $ref: '#/components/schemas/AutoModeIgnoreOptions'
- type: 'null'
description: Options for ignoring specific text types
aggressive_table_extraction:
anyOf:
- type: boolean
- type: 'null'
title: Aggressive Table Extraction
description: Whether to use aggressive table extraction
outlined_table_extraction:
anyOf:
- type: boolean
- type: 'null'
title: Outlined Table Extraction
description: Whether to use outlined table extraction
adaptive_long_table:
anyOf:
- type: boolean
- type: 'null'
title: Adaptive Long Table
description: Whether to use adaptive long table handling
extract_layout:
anyOf:
- type: boolean
- type: 'null'
title: Extract Layout
description: Whether to extract layout information
specialized_chart_parsing:
anyOf:
- type: string
enum:
- agentic_plus
- agentic
- efficient
- type: 'null'
title: Specialized Chart Parsing
description: Enable specialized chart parsing with the specified mode
high_res_ocr:
anyOf:
- type: boolean
- type: 'null'
title: High Res Ocr
description: Whether to use high resolution OCR
language:
anyOf:
- type: string
- type: 'null'
title: Language
description: Primary language of the document
crop_box:
anyOf:
- $ref: '#/components/schemas/AutoModeCropBox'
- type: 'null'
description: Document crop box boundaries
spatial_text:
anyOf:
# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/llamaparse/refs/heads/main/openapi/llamaparse-configurations-api-openapi.yml