Skip to content
Developer Documentation
API Reference

Beta

BetaIndexes

Get Index
IndexGetResponse Beta.Indexes.Get(IndexGetParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/indexes/{index_id}
Delete Index
Beta.Indexes.Delete(IndexDeleteParamsparameters, CancellationTokencancellationToken = default)
DELETE/api/v1/indexes/{index_id}
Create Index
IndexCreateResponse Beta.Indexes.Create(IndexCreateParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/indexes
Sync Index
JsonElement Beta.Indexes.Sync(IndexSyncParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/indexes/{index_id}/sync
List Indexes
IndexListPageResponse Beta.Indexes.List(IndexListParams?parameters, CancellationTokencancellationToken = default)
GET/api/v1/indexes

BetaRetrieval

Retrieve
RetrievalRetrieveResponse Beta.Retrieval.Retrieve(RetrievalRetrieveParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/retrieval/retrieve
Find Files
RetrievalFindPageResponse Beta.Retrieval.Find(RetrievalFindParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/retrieval/files/find
Grep File
RetrievalGrepPageResponse Beta.Retrieval.Grep(RetrievalGrepParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/retrieval/files/grep
Read File
RetrievalReadResponse Beta.Retrieval.Read(RetrievalReadParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/retrieval/files/read

BetaChat

List Sessions
ChatListPageResponse Beta.Chat.List(ChatListParams?parameters, CancellationTokencancellationToken = default)
GET/api/v1/chat
Create Session
ChatCreateResponse Beta.Chat.Create(ChatCreateParams?parameters, CancellationTokencancellationToken = default)
POST/api/v1/chat
Get Full Session
ChatRetrieveResponse Beta.Chat.Retrieve(ChatRetrieveParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/chat/{session_id}
Delete Session
Beta.Chat.Delete(ChatDeleteParamsparameters, CancellationTokencancellationToken = default)
DELETE/api/v1/chat/{session_id}
Get Session Summary
ChatGetSummaryResponse Beta.Chat.GetSummary(ChatGetSummaryParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/chat/{session_id}/summary
Stream Messages
JsonElement Beta.Chat.Stream(ChatStreamParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/chat/{session_id}/messages/stream

BetaAgent Data

Get Agent Data
AgentData Beta.AgentData.Get(AgentDataGetParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/agent-data/{item_id}
Update Agent Data
AgentData Beta.AgentData.Update(AgentDataUpdateParamsparameters, CancellationTokencancellationToken = default)
PUT/api/v1/beta/agent-data/{item_id}
Delete Agent Data
IReadOnlyDictionary<string, string> Beta.AgentData.Delete(AgentDataDeleteParamsparameters, CancellationTokencancellationToken = default)
DELETE/api/v1/beta/agent-data/{item_id}
Create Agent Data
AgentData Beta.AgentData.Create(AgentDataCreateParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/agent-data
Search Agent Data
AgentDataSearchPageResponse Beta.AgentData.Search(AgentDataSearchParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/agent-data/:search
Aggregate Agent Data
AgentDataAggregatePageResponse Beta.AgentData.Aggregate(AgentDataAggregateParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/agent-data/:aggregate
Delete Agent Data By Query
AgentDataDeleteByQueryResponse Beta.AgentData.DeleteByQuery(AgentDataDeleteByQueryParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/agent-data/:delete
ModelsExpand Collapse
class AgentData:

API Result for a single agent data item

required IReadOnlyDictionary<string, JsonElement> Data
required string DeploymentName
string? ID
string Collection
DateTimeOffset? CreatedAt
string? ProjectID
DateTimeOffset? UpdatedAt

BetaSheets

Create Spreadsheet Job
Deprecated
SheetsJob Beta.Sheets.Create(SheetCreateParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/sheets/jobs
List Spreadsheet Jobs
Deprecated
SheetListPageResponse Beta.Sheets.List(SheetListParams?parameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/sheets/jobs
Get Spreadsheet Job
Deprecated
SheetsJob Beta.Sheets.Get(SheetGetParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/sheets/jobs/{spreadsheet_job_id}
Get Result Region
Deprecated
PresignedUrl Beta.Sheets.GetResultTable(SheetGetResultTableParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/sheets/jobs/{spreadsheet_job_id}/regions/{region_id}/result/{region_type}
Delete Spreadsheet Job
Deprecated
JsonElement Beta.Sheets.DeleteJob(SheetDeleteJobParamsparameters, CancellationTokencancellationToken = default)
DELETE/api/v1/beta/sheets/jobs/{spreadsheet_job_id}
ModelsExpand Collapse
class SheetsJob:

A spreadsheet parsing job.

required string ID

The ID of the job

required SheetsParsingConfig Configuration

Configuration applied to the parsing job (inline or resolved from a saved preset).

string? ExtractionRange

A1 notation of the range to extract a single region from. If None, the entire sheet is used.

Boolean FlattenHierarchicalTables

Return a flattened dataframe when a detected table is recognized as hierarchical.

Boolean GenerateAdditionalMetadata

Deprecated: controlled by tier. Whether to generate additional metadata (title, description) for each extracted region. Honored only on agentic.

Boolean IncludeHiddenCells

Whether to include hidden cells when extracting regions from the spreadsheet.

IReadOnlyList<string>? SheetNames

The names of the sheets to extract regions from. If empty, all sheets will be processed.

string? Specialization

Deprecated: controlled by tier. Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline. Honored only on agentic.

TableMergeSensitivity TableMergeSensitivity

Deprecated: controlled by tier. Influences how likely similar-looking regions are merged into a single table. Honored only on agentic.

One of the following:
"strong"Strong
"weak"Weak
Tier Tier

Spreadsheet extraction tier. cost_effective uses the rule-based/ML-only pipeline; agentic uses the full pipeline.

One of the following:
"agentic"Agentic
"cost_effective"CostEffective
Boolean UseExperimentalProcessing

Deprecated: controlled by tier. Enables experimental processing. Honored only on agentic.

required string CreatedAt

When the job was created

required string? FileID

The ID of the input file

formatuuid
required string ProjectID

The ID of the project

formatuuid
required Status Status

The status of the parsing job

One of the following:
"CANCELLED"Cancelled
"ERROR"Error
"PARTIAL_SUCCESS"PartialSuccess
"PENDING"Pending
"SUCCESS"Success
required string UpdatedAt

When the job was last updated

required string UserID

The ID of the user

DeprecatedSheetsParsingConfig? Config

Configuration for spreadsheet parsing and region extraction

string? ExtractionRange

A1 notation of the range to extract a single region from. If None, the entire sheet is used.

Boolean FlattenHierarchicalTables

Return a flattened dataframe when a detected table is recognized as hierarchical.

Boolean GenerateAdditionalMetadata

Deprecated: controlled by tier. Whether to generate additional metadata (title, description) for each extracted region. Honored only on agentic.

Boolean IncludeHiddenCells

Whether to include hidden cells when extracting regions from the spreadsheet.

IReadOnlyList<string>? SheetNames

The names of the sheets to extract regions from. If empty, all sheets will be processed.

string? Specialization

Deprecated: controlled by tier. Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline. Honored only on agentic.

TableMergeSensitivity TableMergeSensitivity

Deprecated: controlled by tier. Influences how likely similar-looking regions are merged into a single table. Honored only on agentic.

One of the following:
"strong"Strong
"weak"Weak
Tier Tier

Spreadsheet extraction tier. cost_effective uses the rule-based/ML-only pipeline; agentic uses the full pipeline.

One of the following:
"agentic"Agentic
"cost_effective"CostEffective
Boolean UseExperimentalProcessing

Deprecated: controlled by tier. Enables experimental processing. Honored only on agentic.

string? ConfigurationID

The saved product configuration ID used at create time, if any.

IReadOnlyList<string> Errors

Any errors encountered

DeprecatedFile? File

Schema for a file.

required string ID

Unique identifier

formatuuid
required string Name
required string ProjectID

The ID of the project that the file belongs to

formatuuid
DateTimeOffset? CreatedAt

Creation datetime

formatdate-time
string? DataSourceID

The ID of the data source that the file belongs to

formatuuid
DateTimeOffset? ExpiresAt

The expiration date for the file. Files past this date can be deleted.

formatdate-time
string? ExternalFileID

The ID of the file in the external system

Long? FileSize

Size of the file in bytes

minimum0
string? FileType

File type (e.g. pdf, docx, etc.)

maxLength3000
minLength1
DateTimeOffset? LastModifiedAt

The last modified time of the file

formatdate-time
IReadOnlyDictionary<string, PermissionInfo?>? PermissionInfo

Permission information for the file

One of the following:
IReadOnlyDictionary<string, JsonElement>
IReadOnlyList<JsonElement>
string
Double
Boolean
string? Purpose

The intended purpose of the file (e.g., ‘user_data’, ‘parse’, ‘extract’, ‘split’, ‘classify’)

IReadOnlyDictionary<string, ResourceInfo?>? ResourceInfo

Resource information for the file

One of the following:
IReadOnlyDictionary<string, JsonElement>
IReadOnlyList<JsonElement>
string
Double
Boolean
DateTimeOffset? UpdatedAt

Update datetime

formatdate-time
IReadOnlyDictionary<string, JsonElement>? MetadataStateTransitions

Per-status entry timestamps. Returned only when requested via ?expand=metadata_state_transitions.

Parameters Parameters

Job-time parameters such as webhook configurations.

IReadOnlyList<WebhookConfiguration>? WebhookConfigurations

Webhook configurations for job status notifications.

IReadOnlyList<WebhookEvent>? WebhookEvents

Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.

One of the following:
"classify.cancelled"ClassifyCancelled
"classify.error"ClassifyError
"classify.partial_success"ClassifyPartialSuccess
"classify.pending"ClassifyPending
"classify.running"ClassifyRunning
"classify.success"ClassifySuccess
"extract.cancelled"ExtractCancelled
"extract.error"ExtractError
"extract.partial_success"ExtractPartialSuccess
"extract.pending"ExtractPending
"extract.success"ExtractSuccess
"parse.cancelled"ParseCancelled
"parse.error"ParseError
"parse.partial_success"ParsePartialSuccess
"parse.pending"ParsePending
"parse.running"ParseRunning
"parse.success"ParseSuccess
"sheets.cancelled"SheetsCancelled
"sheets.error"SheetsError
"sheets.partial_success"SheetsPartialSuccess
"sheets.pending"SheetsPending
"sheets.success"SheetsSuccess
"split.cancelled"SplitCancelled
"split.error"SplitError
"split.pending"SplitPending
"split.processing"SplitProcessing
"split.success"SplitSuccess
"unmapped_event"UnmappedEvent
IReadOnlyDictionary<string, string>? WebhookHeaders

Custom HTTP headers sent with each webhook request (e.g. auth tokens)

string? WebhookOutputFormat

Response format sent to the webhook: ‘string’ (default) or ‘json’

string? WebhookSigningSecret

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.

string? WebhookUrl

URL to receive webhook POST notifications

IReadOnlyList<Region> Regions

All extracted regions (populated when job is complete)

required string Location

Location of the region in the spreadsheet

required string RegionType

Type of the extracted region

required string SheetName

Worksheet name where region was found

string? Description

Generated description for the region

string RegionID

Unique identifier for this region within the file

string? Title

Generated title for the region

Boolean? Success

Whether the job completed successfully

IReadOnlyList<WorksheetMetadata> WorksheetMetadata

Metadata for each processed worksheet (populated when job is complete)

required string SheetName

Name of the worksheet

string? Description

Generated description of the worksheet

string? Title

Generated title for the worksheet

class SheetsParsingConfig:

Configuration for spreadsheet parsing and region extraction

string? ExtractionRange

A1 notation of the range to extract a single region from. If None, the entire sheet is used.

Boolean FlattenHierarchicalTables

Return a flattened dataframe when a detected table is recognized as hierarchical.

Boolean GenerateAdditionalMetadata

Deprecated: controlled by tier. Whether to generate additional metadata (title, description) for each extracted region. Honored only on agentic.

Boolean IncludeHiddenCells

Whether to include hidden cells when extracting regions from the spreadsheet.

IReadOnlyList<string>? SheetNames

The names of the sheets to extract regions from. If empty, all sheets will be processed.

string? Specialization

Deprecated: controlled by tier. Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline. Honored only on agentic.

TableMergeSensitivity TableMergeSensitivity

Deprecated: controlled by tier. Influences how likely similar-looking regions are merged into a single table. Honored only on agentic.

One of the following:
"strong"Strong
"weak"Weak
Tier Tier

Spreadsheet extraction tier. cost_effective uses the rule-based/ML-only pipeline; agentic uses the full pipeline.

One of the following:
"agentic"Agentic
"cost_effective"CostEffective
Boolean UseExperimentalProcessing

Deprecated: controlled by tier. Enables experimental processing. Honored only on agentic.

BetaDirectories

Create Directory
DirectoryCreateResponse Beta.Directories.Create(DirectoryCreateParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/directories
List Directories
DirectoryListPageResponse Beta.Directories.List(DirectoryListParams?parameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/directories
Get Directory
DirectoryGetResponse Beta.Directories.Get(DirectoryGetParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/directories/{directory_id}
Update Directory
DirectoryUpdateResponse Beta.Directories.Update(DirectoryUpdateParamsparameters, CancellationTokencancellationToken = default)
PATCH/api/v1/beta/directories/{directory_id}
Delete Directory
Beta.Directories.Delete(DirectoryDeleteParamsparameters, CancellationTokencancellationToken = default)
DELETE/api/v1/beta/directories/{directory_id}

BetaDirectoriesFiles

Add Directory File
FileAddResponse Beta.Directories.Files.Add(FileAddParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/directories/{directory_id}/files
List Directory Files
FileListPageResponse Beta.Directories.Files.List(FileListParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/directories/{directory_id}/files
Get Directory File
FileGetResponse Beta.Directories.Files.Get(FileGetParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Update Directory File
FileUpdateResponse Beta.Directories.Files.Update(FileUpdateParamsparameters, CancellationTokencancellationToken = default)
PATCH/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Delete Directory File
Beta.Directories.Files.Delete(FileDeleteParamsparameters, CancellationTokencancellationToken = default)
DELETE/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Upload File To Directory
FileUploadResponse Beta.Directories.Files.Upload(FileUploadParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/directories/{directory_id}/files/upload

BetaBatch

Create Batch Job
BatchCreateResponse Beta.Batch.Create(BatchCreateParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/batch-processing
List Batch Jobs
BatchListPageResponse Beta.Batch.List(BatchListParams?parameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/batch-processing
Get Batch Job Status
BatchGetStatusResponse Beta.Batch.GetStatus(BatchGetStatusParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/batch-processing/{job_id}
Cancel Batch Job
BatchCancelResponse Beta.Batch.Cancel(BatchCancelParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/batch-processing/{job_id}/cancel

BetaBatchJob Items

List Batch Job Items
JobItemListPageResponse Beta.Batch.JobItems.List(JobItemListParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/batch-processing/{job_id}/items
Get Item Processing Results
JobItemGetProcessingResultsResponse Beta.Batch.JobItems.GetProcessingResults(JobItemGetProcessingResultsParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/batch-processing/items/{item_id}/processing-results

BetaSplit

Create Split Job
SplitCreateResponse Beta.Split.Create(SplitCreateParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/beta/split/jobs
List Split Jobs
SplitListPageResponse Beta.Split.List(SplitListParams?parameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/split/jobs
Get Split Job
SplitGetResponse Beta.Split.Get(SplitGetParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/beta/split/jobs/{split_job_id}
ModelsExpand Collapse
class SplitCategory:

Category definition for document splitting.

required string Name

Name of the category.

maxLength200
minLength1
string? Description

Optional description of what content belongs in this category.

maxLength2000
minLength1
class SplitDocumentInput:

Document input specification for beta API.

required string Type

Type of document input. Valid values are: file_id

required string Value

Document identifier.

class SplitResultResponse:

Result of a completed split job.

required IReadOnlyList<SplitSegmentResponse> Segments

List of document segments.

required string Category

Category name this split belongs to.

required string ConfidenceCategory

Categorical confidence level. Valid values are: high, medium, low.

required IReadOnlyList<Long> Pages

1-indexed page numbers in this split.

class SplitSegmentResponse:

A segment of the split document.

required string Category

Category name this split belongs to.

required string ConfidenceCategory

Categorical confidence level. Valid values are: high, medium, low.

required IReadOnlyList<Long> Pages

1-indexed page numbers in this split.

Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/for-agents/mcp/ - Other LlamaIndex tooling for agents — the LlamaParse Platform MCP server, agent skills and plugins, and the n8n node — is mapped at https://developers.llamaindex.ai/for-agents/