Skip to content

Beta

BetaIndexes

Get Index

IndexGetResponse Beta.Indexes.Get(, )

GET/api/v1/indexes/{index_id}

Delete Index

Beta.Indexes.Delete(, )

DELETE/api/v1/indexes/{index_id}

Create Index

IndexCreateResponse Beta.Indexes.Create(, )

POST/api/v1/indexes

Sync Index

JsonElement Beta.Indexes.Sync(, )

POST/api/v1/indexes/{index_id}/sync

List Indexes

IndexListPageResponse Beta.Indexes.List(, )

GET/api/v1/indexes

BetaRetrieval

Retrieve

RetrievalRetrieveResponse Beta.Retrieval.Retrieve(, )

POST/api/v1/retrieval/retrieve

Find Files

RetrievalFindPageResponse Beta.Retrieval.Find(, )

POST/api/v1/retrieval/files/find

Grep File

RetrievalGrepPageResponse Beta.Retrieval.Grep(, )

POST/api/v1/retrieval/files/grep

Read File

RetrievalReadResponse Beta.Retrieval.Read(, )

POST/api/v1/retrieval/files/read

BetaChat

List Sessions

ChatListPageResponse Beta.Chat.List(, )

GET/api/v1/chat

Create Session

ChatCreateResponse Beta.Chat.Create(, )

POST/api/v1/chat

Get Full Session

ChatRetrieveResponse Beta.Chat.Retrieve(, )

GET/api/v1/chat/{session_id}

Delete Session

Beta.Chat.Delete(, )

DELETE/api/v1/chat/{session_id}

Get Session Summary

ChatGetSummaryResponse Beta.Chat.GetSummary(, )

GET/api/v1/chat/{session_id}/summary

Stream Messages

JsonElement Beta.Chat.Stream(, )

POST/api/v1/chat/{session_id}/messages/stream

BetaAgent Data

Get Agent Data

AgentData Beta.AgentData.Get(, )

GET/api/v1/beta/agent-data/{item_id}

Update Agent Data

AgentData Beta.AgentData.Update(, )

PUT/api/v1/beta/agent-data/{item_id}

Delete Agent Data

IReadOnlyDictionary<string, string> Beta.AgentData.Delete(, )

DELETE/api/v1/beta/agent-data/{item_id}

Create Agent Data

AgentData Beta.AgentData.Create(, )

POST/api/v1/beta/agent-data

Search Agent Data

AgentDataSearchPageResponse Beta.AgentData.Search(, )

POST/api/v1/beta/agent-data/:search

Aggregate Agent Data

AgentDataAggregatePageResponse Beta.AgentData.Aggregate(, )

POST/api/v1/beta/agent-data/:aggregate

Delete Agent Data By Query

AgentDataDeleteByQueryResponse Beta.AgentData.DeleteByQuery(, )

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

BetaDirectories

Create Directory

DirectoryCreateResponse Beta.Directories.Create(, )

POST/api/v1/beta/directories

List Directories

DirectoryListPageResponse Beta.Directories.List(, )

GET/api/v1/beta/directories

Get Directory

DirectoryGetResponse Beta.Directories.Get(, )

GET/api/v1/beta/directories/{directory_id}

Update Directory

DirectoryUpdateResponse Beta.Directories.Update(, )

PATCH/api/v1/beta/directories/{directory_id}

Delete Directory

Beta.Directories.Delete(, )

DELETE/api/v1/beta/directories/{directory_id}

BetaDirectoriesFiles

Add Directory File

FileAddResponse Beta.Directories.Files.Add(, )

POST/api/v1/beta/directories/{directory_id}/files

List Directory Files

FileListPageResponse Beta.Directories.Files.List(, )

GET/api/v1/beta/directories/{directory_id}/files

Get Directory File

FileGetResponse Beta.Directories.Files.Get(, )

GET/api/v1/beta/directories/{directory_id}/files/{directory_file_id}

Update Directory File

FileUpdateResponse Beta.Directories.Files.Update(, )

PATCH/api/v1/beta/directories/{directory_id}/files/{directory_file_id}

Delete Directory File

Beta.Directories.Files.Delete(, )

DELETE/api/v1/beta/directories/{directory_id}/files/{directory_file_id}

Upload File To Directory

FileUploadResponse Beta.Directories.Files.Upload(, )

POST/api/v1/beta/directories/{directory_id}/files/upload

BetaSplit

Create Split Job

SplitCreateResponse Beta.Split.Create(, )

POST/api/v1/beta/split/jobs

List Split Jobs

SplitListPageResponse Beta.Split.List(, )

GET/api/v1/beta/split/jobs

Get Split Job

SplitGetResponse Beta.Split.Get(, )

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/