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

JsonValue beta().indexes().sync(, )

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

List Indexes

IndexListPage beta().indexes().list(, )

GET/api/v1/indexes

BetaRetrieval

Retrieve

RetrievalRetrieveResponse beta().retrieval().retrieve(, )

POST/api/v1/retrieval/retrieve

Find Files

RetrievalFindPage beta().retrieval().find(, )

POST/api/v1/retrieval/files/find

Grep File

RetrievalGrepPage beta().retrieval().grep(, )

POST/api/v1/retrieval/files/grep

Read File

RetrievalReadResponse beta().retrieval().read(, )

POST/api/v1/retrieval/files/read

BetaChat

List Sessions

ChatListPage 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

JsonValue 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

AgentDataDeleteResponse 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

AgentDataSearchPage beta().agentData().search(, )

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

Aggregate Agent Data

AgentDataAggregatePage 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

Data data

String deploymentName

Optional<String> id

Optional<String> collection

Optional<LocalDateTime> createdAt

Optional<String> projectId

Optional<LocalDateTime> updatedAt

BetaDirectories

Create Directory

DirectoryCreateResponse beta().directories().create(, )

POST/api/v1/beta/directories

List Directories

DirectoryListPage 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

FileListPage 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

SplitListPage 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.

String name

Name of the category.

maxLength200

minLength1

Optional<String> description

Optional description of what content belongs in this category.

maxLength2000

minLength1

class SplitDocumentInput:

Document input specification for beta API.

String type

Type of document input. Valid values are: file_id

String value

Document identifier.

class SplitResultResponse:

Result of a completed split job.

List<SplitSegmentResponse> segments

List of document segments.

String category

Category name this split belongs to.

String confidenceCategory

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

List<long> pages

1-indexed page numbers in this split.

class SplitSegmentResponse:

A segment of the split document.

String category

Category name this split belongs to.

String confidenceCategory

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

List<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/