The identity and technical contract details declared by the specification.
BatchJobStatus
string
Status of a batch processing job.
SplitCategory
object
Category definition for document splitting.
2 properties
1 required
FileFilter
object
Filter parameters for file queries.
6 properties
UntypedParameters
object
Catch-all for configurations without a dedicated typed schema. Accepts arbitrary JSON fields alongside producttype.
1 property
1 required
SplitConfiguration
object
Split configuration with categories and splitting strategy.
2 properties
1 required
DirectoryFileQueryResponse
object
API query response schema for directory files.
3 properties
1 required
LlamaParseOutputOptions
object
Output formatting and content extraction options. Controls how parsed content is formatted and what additional data is extracted.
7 properties
BatchJobQueryResponse
object
Response schema for paginated batch job queries.
3 properties
1 required
PaginatedResponse_AgentData_
object
3 properties
1 required
AggregateRequest
object
API request body for aggregating agent data
10 properties
1 required
DirectoryFileCreateRequest
object
API request schema for creating a directory file.
4 properties
1 required
FileClassification
object
A file classification.
6 properties
2 required
LlamaParseSpatialTextOptions
object
Spatial text output options for preserving document layout. Spatial text maintains the visual positioning of text elements, useful for documents where layout c…
3 properties
FileQueryRequest
object
Request schema for querying files with pagination and filtering.
4 properties
BatchJobResponse
object
Response schema for a batch processing job.
17 properties
5 required
SpreadsheetResultType
string
BatchJobCreateRequest
object
Request to create a batch processing job. Supports two modes: 1. Directory mode: Process all files in a directory (use directoryid) 2. Item list mode: Process…
5 properties
1 required
DirectoryResponse
object
API response schema for a directory.
10 properties
3 required
StatusEnum
string
Enum for representing the status of a job
ExtractedRegionSummary
object
A summary of a single extracted region from a spreadsheet
6 properties
3 required
SplitStrategy
object
Configuration for how to split the document.
1 property
File
object
Schema for a file.
14 properties
3 required
LlamaParsePdfOptions
object
ClassifyMode
string
Supported classification execution modes.
AgentDataUpdate
object
API request model for updating agent data
1 property
1 required
ItemProcessingResultsResponse
object
Response containing all processing results for an item.
3 properties
2 required
ConfigurationUpdateRequest
object
Request body for updating a product configuration.
2 properties
ProcessingResultMetadata
object
Metadata about processing output. Currently empty - will be populated with job-type-specific metadata fields in the future.
LlamaParsePresentationOptions
object
Presentation (PowerPoint, Keynote, ODP) parsing options.
2 properties
SearchRequest
object
API request body for searching agent data
8 properties
1 required
ProcessingResult
object
A processing result with lineage information.
8 properties
7 required
SplitJobQueryResponse
object
Beta paginated list of split jobs.
3 properties
1 required
BatchJobCancelRequest
object
Request to cancel a running batch job.
1 property
LlamaParsePageRanges
object
Page selection options for processing specific pages or limiting page count.
2 properties
AgentDataCreate
object
API request model for creating agent data
3 properties
2 required
LlamaParseWebhookConfiguration
object
Webhook configuration for receiving parsing job notifications. Webhooks are called when specified events occur during job processing. Configure multiple webhoo…
4 properties
SpreadsheetJobParameters
object
Job-time parameters returned on a spreadsheet job response.
1 property
ExtractV2Parameters
object
Typed parameters for an extract v2 product configuration.
12 properties
2 required
LlamaParseTables
object
Table formatting options for markdown output.
4 properties
DirectoryQueryResponse
object
API query response schema for directories.
3 properties
1 required
ParsingMode
string
Enum for representing the mode of parsing to be used.
LlamaParseHtmlOptions
object
HTML/web page parsing options.
3 properties
ClassifyV2Rule
object
A rule for classifying documents.
2 properties
2 required
ClassifyV2ParsingConfiguration
object
Parsing configuration for classify jobs.
3 properties
ClassifyParsingConfiguration
object
Parsing configuration for a classify job.
3 properties
LlamaParseInputOptions
object
Input format-specific parsing options. These options only apply when parsing documents of the corresponding format. LlamaParse automatically detects the input…
4 properties
BatchParseJobConfig
object
Generic parse job configuration for batch processing. This model contains the parsing configuration that applies to all files in a batch, but excludes file-spe…
125 properties
DirectoryFileUpdateRequest
object
API request schema for updating a directory file.
4 properties
PartitionNames
string
Enum for dataset partition names.
WebhookConfiguration
object
Configuration for a single outbound webhook endpoint.
4 properties
DirectoryFileResponse
object
API response schema for a directory file.
11 properties
5 required
DirectoryCreateRequest
object
API request schema for creating a directory.
5 properties
1 required
ParserLanguages
string
Enum for representing the languages supported by the parser.
LlamaParseOcrParameters
object
OCR (Optical Character Recognition) configuration parameters.
1 property
FileQueryResponseV2
object
Paginated list of files.
3 properties
1 required
ParseV2Parameters
object
Configuration for LlamaParse v2 document parsing. Includes tier selection, processing options, output formatting, page targeting, and webhook delivery. Refer t…
14 properties
3 required
AutoModeCropBox
object
Crop box options for auto mode parsing configuration.
4 properties
SpreadsheetJobCreate
object
Request to create a spreadsheet parsing job. Provide at most one of configuration (inline) or configurationid (saved preset). If neither is provided, a default…
5 properties
1 required
BatchFileStatus
string
Status of an individual file in a batch job.
ClassifyJob
object
A classify job.
12 properties
5 required
LlamaParseIgnoreOptions
object
Options for ignoring specific types of text during extraction.
3 properties
SpreadsheetV1Parameters
object
Typed parameters for a spreadsheet v1 product configuration.
9 properties
1 required
PresignedUrl
object
Schema for a presigned URL.
3 properties
2 required
AutoModeConfigurationEntry
object
A single auto mode rule with trigger conditions and parsing configuration. Auto mode allows conditional parsing where different configurations are applied base…
36 properties
1 required
UsageMetric
object
API boundary representation of a usage metric.
11 properties
9 required
PipelineFileResponse
object
Beta API response schema for a pipeline file.
17 properties
2 required
PaginatedResponse_ClassifyJob_
object
3 properties
1 required
ClassificationResult
object
Result of classifying a single file.
3 properties
3 required
ClassifyJobCreate
object
A classify job.
5 properties
2 required
DeleteRequest
object
API request body for bulk deleting agent data by query
3 properties
1 required
PaginatedResponse_SpreadsheetJob_
object
3 properties
1 required
DirectoryFileBulkDeleteRequest
object
API request schema for bulk deleting directory files.
1 property
1 required
SplitSegmentResponse
object
A segment of the split document.
3 properties
3 required
AutoModeIgnoreOptions
object
Ignore options for auto mode parsing configuration.
2 properties
LlamaParseCropBox
object
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-r…
4 properties
LlamaParseCostOptimizerParameters
object
Cost optimizer configuration for reducing parsing costs on simpler pages. When enabled, the parser analyzes each page and routes simpler pages to faster, cheap…
1 property
SplitDocumentInput
object
Document input specification for beta API.
2 properties
2 required
BatchItemListResponse
object
Paginated response containing batch job item details.
3 properties
LlamaParseAgenticOptions
object
Options for AI-powered parsing tiers (costeffective, agentic, agenticplus). These options customize how the AI processes and interprets document content. Only…
1 property
LlamaParseTablesAsSpreadsheetOptions
object
Options for exporting extracted tables as XLSX spreadsheet files.
2 properties
DeleteResponse
object
API response for bulk delete operation
1 property
1 required
HTTPValidationError
object
1 property
Body_upload_file_api_v1_beta_files_post
object
3 properties
2 required
LlamaParseSpreadsheetOptions
object
Spreadsheet (Excel, CSV, ODS) parsing options.
3 properties
ConfigurationQueryResponse
object
Paginated list of product configurations.
3 properties
1 required
ConfigurationCreateRequest
object
Request body for creating a product configuration.
2 properties
2 required
AgentData
object
API Result for a single agent data item
7 properties
2 required
SplitJobResponse
object
Beta response — uses nested documentinput object.
11 properties
6 required
FailPageMode
string
Enum for representing the different available page error handling modes.
ConfigurationResponse
object
Response schema for a single product configuration.
7 properties
5 required
UsageMetricQueryResponse
object
Paginated response containing usage metrics.
3 properties
1 required
LlamaParseTimeouts
object
Job timeout configuration. Total timeout = baseinseconds + (extratimeperpageinseconds × pagecount). Use these settings for large documents or complex parsing t…
2 properties
FilterOperation
object
API request model for a filter comparison operation.
8 properties
AutoModePresentationOptions
object
Presentation-specific options for auto mode parsing configuration.
2 properties
BatchItemDetail
object
Detailed information about an item in a batch job.
10 properties
3 required
BatchJobCancelResponse
object
Response after cancelling a batch job.
4 properties
4 required
FileV2
object
An uploaded file.
9 properties
3 required
SplitV1Parameters
object
Typed parameters for a split v1 product configuration.
3 properties
2 required
AggregateGroup
object
API Result for a single group in the aggregate response
3 properties
1 required
PipelineFileListResponse
object
Beta API query response schema for pipeline files.
3 properties
1 required
LlamaParseProcessingOptions
object
Processing options shared across all parsing tiers. These options control how documents are analyzed and processed regardless of the selected tier. Some option…
7 properties
Body_upload_file_to_directory_api_v1_beta_directories__directory_id__files_upload_post
object
5 properties
1 required
SpreadsheetJob
object
A spreadsheet parsing job.
17 properties
8 required
ClassifyJobResults
object
Response model for the classify endpoint following AIP-132 pagination standard.
3 properties
1 required
SplitCreateRequest
object
Beta create request — accepts legacy documentinput and flat formats.
3 properties
1 required
BatchJobStatusResponse
object
Detailed status response for a batch processing job.
2 properties
2 required
AutoModeParsingConf
object
Parsing configuration applied when auto mode triggers match. These settings override the base configuration for pages where trigger conditions are satisfied. O…
14 properties
ClassifyV2Parameters
object
Typed parameters for a classify v2 product configuration.
4 properties
2 required
WorksheetMetadata
object
Metadata about a worksheet in a spreadsheet
3 properties
1 required
LlamaParseFastOptions
object
Options for fast tier parsing (rule-based, no AI). Fast tier uses deterministic algorithms for text extraction without AI enhancement. It's the fastest and mos…
LlamaParseJobFailureConditions
object
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 pa…
5 properties
DirectoryUpdateRequest
object
API request schema for updating a directory.
2 properties
SpreadsheetParsingConfig
object
Configuration for spreadsheet parsing and region extraction
8 properties
ClassifierRule
object
A rule for classifying documents - v0 simplified version. This represents a single classification rule that will be applied to documents. All rules are content…
2 properties
2 required
LlamaParseProcessingControl
object
Job processing controls for timeouts and failure handling.
2 properties
BatchJobType
string
Type of batch processing operation.
PaginatedResponse_AggregateGroup_
object
3 properties
1 required
LlamaParseMarkdownOptions
object
Markdown output formatting options.
3 properties
BatchParseJobRecordCreate
object
Batch-specific parse job record for batch processing. This model contains the metadata and configuration for a batch parse job, but excludes file-specific info…
9 properties
ValidationError
object
5 properties
3 required
AutoModeSpatialTextOptions
object
Spatial text options for auto mode parsing configuration.
3 properties
SplitResultResponse
object
Result of a completed split job.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs LlamaParse publishes across the network.