Skip to content

Beta

BetaIndexes

Get Index
$ llp beta:indexes get
GET/api/v1/indexes/{index_id}
Delete Index
$ llp beta:indexes delete
DELETE/api/v1/indexes/{index_id}
Create Index
$ llp beta:indexes create
POST/api/v1/indexes
Sync Index
$ llp beta:indexes sync
POST/api/v1/indexes/{index_id}/sync
List Indexes
$ llp beta:indexes list
GET/api/v1/indexes

BetaRetrieval

Retrieve
$ llp beta:retrieval retrieve
POST/api/v1/retrieval/retrieve
Find Files
$ llp beta:retrieval find
POST/api/v1/retrieval/files/find
Grep File
$ llp beta:retrieval grep
POST/api/v1/retrieval/files/grep
Read File
$ llp beta:retrieval read
POST/api/v1/retrieval/files/read

BetaChat

List Sessions
$ llp beta:chat list
GET/api/v1/chat
Create Session
$ llp beta:chat create
POST/api/v1/chat
Get Full Session
$ llp beta:chat retrieve
GET/api/v1/chat/{session_id}
Delete Session
$ llp beta:chat delete
DELETE/api/v1/chat/{session_id}
Get Session Summary
$ llp beta:chat get-summary
GET/api/v1/chat/{session_id}/summary
Stream Messages
$ llp beta:chat stream
POST/api/v1/chat/{session_id}/messages/stream

BetaAgent Data

Get Agent Data
$ llp beta:agent-data get
GET/api/v1/beta/agent-data/{item_id}
Update Agent Data
$ llp beta:agent-data update
PUT/api/v1/beta/agent-data/{item_id}
Delete Agent Data
$ llp beta:agent-data delete
DELETE/api/v1/beta/agent-data/{item_id}
Create Agent Data
$ llp beta:agent-data create
POST/api/v1/beta/agent-data
Search Agent Data
$ llp beta:agent-data search
POST/api/v1/beta/agent-data/:search
Aggregate Agent Data
$ llp beta:agent-data aggregate
POST/api/v1/beta/agent-data/:aggregate
Delete Agent Data By Query
$ llp beta:agent-data delete-by-query
POST/api/v1/beta/agent-data/:delete
ModelsExpand Collapse
agent_data: object { data, deployment_name, id, 4 more }

API Result for a single agent data item

data: map[unknown]
deployment_name: string
id: optional string
collection: optional string
created_at: optional string
project_id: optional string
updated_at: optional string

BetaDirectories

Create Directory
$ llp beta:directories create
POST/api/v1/beta/directories
List Directories
$ llp beta:directories list
GET/api/v1/beta/directories
Get Directory
$ llp beta:directories get
GET/api/v1/beta/directories/{directory_id}
Update Directory
$ llp beta:directories update
PATCH/api/v1/beta/directories/{directory_id}
Delete Directory
$ llp beta:directories delete
DELETE/api/v1/beta/directories/{directory_id}

BetaDirectoriesFiles

Add Directory File
$ llp beta:directories:files add
POST/api/v1/beta/directories/{directory_id}/files
List Directory Files
$ llp beta:directories:files list
GET/api/v1/beta/directories/{directory_id}/files
Get Directory File
$ llp beta:directories:files get
GET/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Update Directory File
$ llp beta:directories:files update
PATCH/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Delete Directory File
$ llp beta:directories:files delete
DELETE/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Upload File To Directory
$ llp beta:directories:files upload
POST/api/v1/beta/directories/{directory_id}/files/upload

BetaSplit

Create Split Job
$ llp beta:split create
POST/api/v1/beta/split/jobs
List Split Jobs
$ llp beta:split list
GET/api/v1/beta/split/jobs
Get Split Job
$ llp beta:split get
GET/api/v1/beta/split/jobs/{split_job_id}
ModelsExpand Collapse
split_category: object { name, description }

Category definition for document splitting.

name: string

Name of the category.

description: optional string

Optional description of what content belongs in this category.

split_document_input: object { type, value }

Document input specification for beta API.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

split_result_response: object { segments }

Result of a completed split job.

segments: array of SplitSegmentResponse { category, confidence_category, pages }

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

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

pages: array of number

1-indexed page numbers in this split.

split_segment_response: object { category, confidence_category, pages }

A segment of the split document.

category: string

Category name this split belongs to.

confidence_category: string

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

pages: array of number

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/