API Reference

Libraries

TypeScript

2.9.0

npm install @llamaindex/llama-cloud

Read Docs

Python

2.9.0

pip install llama_cloud

Read Docs

Java

0.0.1

implementation("com.llamacloud_prod.api:llama-cloud-java:0.0.1")

Read Docs

Go

0.0.1

go get -u 'github.com/run-llama/llama-parse-go@v0.0.1'

Read Docs

CLI tool

0.0.1

Read Docs

API Overview

Files

Upload File

POST/api/v1/beta/files

Query Files

Deprecated

POST/api/v1/beta/files/query

List Files

GET/api/v1/beta/files

Delete File

DELETE/api/v1/beta/files/{file_id}

Read File Content

GET/api/v1/beta/files/{file_id}/content

Parsing

Parse File

POST/api/v2/parse

Get Parse Job

GET/api/v2/parse/{job_id}

List Parse Jobs

GET/api/v2/parse

Extract

Create Extract Job

POST/api/v2/extract

List Extract Jobs

GET/api/v2/extract

Get Extract Job

GET/api/v2/extract/{job_id}

Delete Extract Job

DELETE/api/v2/extract/{job_id}

Validate Extraction Schema

POST/api/v2/extract/schema/validation

Generate Extraction Schema

POST/api/v2/extract/schema/generate

Classifier

ClassifierJobs

Create Classify Job

Deprecated

POST/api/v1/classifier/jobs

List Classify Jobs

Deprecated

GET/api/v1/classifier/jobs

Get Classify Job

Deprecated

GET/api/v1/classifier/jobs/{classify_job_id}

Get Classification Job Results

Deprecated

GET/api/v1/classifier/jobs/{classify_job_id}/results

Batches

Create Batch

POST/api/v2/batches

List Batches

GET/api/v2/batches

Get Batch

GET/api/v2/batches/{batch_id}

Classify

Create Classify Job

POST/api/v2/classify

List Classify Jobs

GET/api/v2/classify

Get Classify Job

GET/api/v2/classify/{job_id}

Configurations

Create Configuration

POST/api/v1/beta/configurations

List Configurations

GET/api/v1/beta/configurations

Get Configuration

GET/api/v1/beta/configurations/{config_id}

Update Configuration

PUT/api/v1/beta/configurations/{config_id}

Delete Configuration

DELETE/api/v1/beta/configurations/{config_id}

Projects

List Projects

GET/api/v1/projects

Get Project

GET/api/v1/projects/{project_id}

Data Sinks

List Data Sinks

GET/api/v1/data-sinks

Create Data Sink

POST/api/v1/data-sinks

Get Data Sink

GET/api/v1/data-sinks/{data_sink_id}

Update Data Sink

PUT/api/v1/data-sinks/{data_sink_id}

Delete Data Sink

DELETE/api/v1/data-sinks/{data_sink_id}

Data Sources

List Data Sources

GET/api/v1/data-sources

Create Data Source

POST/api/v1/data-sources

Get Data Source

GET/api/v1/data-sources/{data_source_id}

Update Data Source

PUT/api/v1/data-sources/{data_source_id}

Delete Data Source

DELETE/api/v1/data-sources/{data_source_id}

Pipelines

Search Pipelines

Deprecated

GET/api/v1/pipelines

Create Pipeline

Deprecated

POST/api/v1/pipelines

Get Pipeline

Deprecated

GET/api/v1/pipelines/{pipeline_id}

Update Existing Pipeline

Deprecated

PUT/api/v1/pipelines/{pipeline_id}

Delete Pipeline

Deprecated

DELETE/api/v1/pipelines/{pipeline_id}

Get Pipeline Status

Deprecated

GET/api/v1/pipelines/{pipeline_id}/status

Upsert Pipeline

Deprecated

PUT/api/v1/pipelines

Run Search

Deprecated

POST/api/v1/pipelines/{pipeline_id}/retrieve

PipelinesSync

Sync Pipeline

Deprecated

POST/api/v1/pipelines/{pipeline_id}/sync

Cancel Pipeline Sync

Deprecated

POST/api/v1/pipelines/{pipeline_id}/sync/cancel

PipelinesData Sources

List Pipeline Data Sources

Deprecated

GET/api/v1/pipelines/{pipeline_id}/data-sources

Add Data Sources To Pipeline

Deprecated

PUT/api/v1/pipelines/{pipeline_id}/data-sources

Update Pipeline Data Source

Deprecated

PUT/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}

Get Pipeline Data Source Status

Deprecated

GET/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/status

Sync Pipeline Data Source

Deprecated

POST/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/sync

PipelinesImages

List File Page Screenshots

GET/api/v1/files/{id}/page_screenshots

Get File Page Screenshot

GET/api/v1/files/{id}/page_screenshots/{page_index}

Get File Page Figure

GET/api/v1/files/{id}/page-figures/{page_index}/{figure_name}

List File Pages Figures

GET/api/v1/files/{id}/page-figures

PipelinesFiles

Get Pipeline File Status Counts

Deprecated

GET/api/v1/pipelines/{pipeline_id}/files/status-counts

Get Pipeline File Status

Deprecated

GET/api/v1/pipelines/{pipeline_id}/files/{file_id}/status

Add Files To Pipeline Api

Deprecated

PUT/api/v1/pipelines/{pipeline_id}/files

Update Pipeline File

Deprecated

PUT/api/v1/pipelines/{pipeline_id}/files/{file_id}

Delete Pipeline File

Deprecated

DELETE/api/v1/pipelines/{pipeline_id}/files/{file_id}

List Pipeline Files2

Deprecated

GET/api/v1/pipelines/{pipeline_id}/files2

PipelinesMetadata

Import Pipeline Metadata

Deprecated

PUT/api/v1/pipelines/{pipeline_id}/metadata

Delete Pipeline Files Metadata

Deprecated

DELETE/api/v1/pipelines/{pipeline_id}/metadata

PipelinesDocuments

Create Batch Pipeline Documents

Deprecated

POST/api/v1/pipelines/{pipeline_id}/documents

Paginated List Pipeline Documents

Deprecated

GET/api/v1/pipelines/{pipeline_id}/documents/paginated

Get Pipeline Document

Deprecated

GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}

Delete Pipeline Document

Deprecated

DELETE/api/v1/pipelines/{pipeline_id}/documents/{document_id}

Get Pipeline Document Status

Deprecated

GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status

Sync Pipeline Document

Deprecated

POST/api/v1/pipelines/{pipeline_id}/documents/{document_id}/sync

List Pipeline Document Chunks

Deprecated

GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}/chunks

Upsert Batch Pipeline Documents

Deprecated

PUT/api/v1/pipelines/{pipeline_id}/documents

Retrievers

Create Retriever

POST/api/v1/retrievers

Upsert Retriever

PUT/api/v1/retrievers

List Retrievers

GET/api/v1/retrievers

Get Retriever

GET/api/v1/retrievers/{retriever_id}

Update Retriever

PUT/api/v1/retrievers/{retriever_id}

Delete Retriever

DELETE/api/v1/retrievers/{retriever_id}

Direct Retrieve

POST/api/v1/retrievers/retrieve

RetrieversRetriever

Retrieve

POST/api/v1/retrievers/{retriever_id}/retrieve

Beta

BetaIndexes

Get Index

GET/api/v1/indexes/{index_id}

Delete Index

DELETE/api/v1/indexes/{index_id}

Create Index

POST/api/v1/indexes

Sync Index

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

List Indexes

GET/api/v1/indexes

BetaRetrieval

Retrieve

POST/api/v1/retrieval/retrieve

Find Files

POST/api/v1/retrieval/files/find

Grep File

POST/api/v1/retrieval/files/grep

Read File

POST/api/v1/retrieval/files/read

BetaChat

List Sessions

GET/api/v1/chat

Create Session

POST/api/v1/chat

Get Full Session

GET/api/v1/chat/{session_id}

Delete Session

DELETE/api/v1/chat/{session_id}

Get Session Summary

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

Stream Messages

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

BetaAgent Data

Get Agent Data

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

Update Agent Data

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

Delete Agent Data

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

Create Agent Data

POST/api/v1/beta/agent-data

Search Agent Data

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

Aggregate Agent Data

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

Delete Agent Data By Query

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

BetaSheets

Create Spreadsheet Job

Deprecated

POST/api/v1/beta/sheets/jobs

List Spreadsheet Jobs

Deprecated

GET/api/v1/beta/sheets/jobs

Get Spreadsheet Job

Deprecated

GET/api/v1/beta/sheets/jobs/{spreadsheet_job_id}

Get Result Region

Deprecated

GET/api/v1/beta/sheets/jobs/{spreadsheet_job_id}/regions/{region_id}/result/{region_type}

Delete Spreadsheet Job

Deprecated

DELETE/api/v1/beta/sheets/jobs/{spreadsheet_job_id}

BetaDirectories

Create Directory

POST/api/v1/beta/directories

List Directories

GET/api/v1/beta/directories

Get Directory

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

Update Directory

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

Delete Directory

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

BetaDirectoriesFiles

Add Directory File

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

List Directory Files

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

Get Directory File

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

Update Directory File

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

Delete Directory File

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

Upload File To Directory

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

BetaBatch

Create Batch Job

POST/api/v1/beta/batch-processing

List Batch Jobs

GET/api/v1/beta/batch-processing

Get Batch Job Status

GET/api/v1/beta/batch-processing/{job_id}

Cancel Batch Job

POST/api/v1/beta/batch-processing/{job_id}/cancel

BetaBatchJob Items

List Batch Job Items

GET/api/v1/beta/batch-processing/{job_id}/items

Get Item Processing Results

GET/api/v1/beta/batch-processing/items/{item_id}/processing-results

BetaSplit

Create Split Job

POST/api/v1/beta/split/jobs

List Split Jobs

GET/api/v1/beta/split/jobs

Get Split Job

GET/api/v1/beta/split/jobs/{split_job_id}