LlamaParse Pipelines API
The Pipelines API from LlamaParse — 16 operation(s) for pipelines.
OpenAPI Specification
openapi: 3.0.3
info:
title: Llama Platform Agent Data Pipelines API
version: 0.1.0
tags:
- name: Pipelines
paths:
/api/v1/pipelines:
get:
tags:
- Pipelines
summary: Search Pipelines
description: Search for pipelines by name, type, or project.
operationId: search_pipelines_api_v1_pipelines_get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: project_name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Project Name
- name: pipeline_name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Pipeline Name
- name: pipeline_type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/PipelineType'
- type: 'null'
title: Pipeline Type
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pipeline'
title: Response Search Pipelines Api V1 Pipelines Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Pipelines
summary: Create Pipeline
description: 'Create a new managed ingestion pipeline.
A pipeline connects data sources to a vector store for RAG.
After creation, call `POST /pipelines/{id}/sync` to start
ingesting documents.'
operationId: create_pipeline_api_v1_pipelines_post
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Pipeline'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Pipelines
summary: Upsert Pipeline
description: 'Upsert a pipeline.
Updates the pipeline if one with the same name and project
already exists, otherwise creates a new one.'
operationId: upsert_pipeline_api_v1_pipelines_put
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Pipeline'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}:
get:
tags:
- Pipelines
summary: Get Pipeline
description: Get a pipeline by ID.
operationId: get_pipeline_api_v1_pipelines__pipeline_id__get
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Pipeline'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Pipelines
summary: Update Existing Pipeline
description: Update an existing pipeline's configuration.
operationId: update_existing_pipeline_api_v1_pipelines__pipeline_id__put
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Pipeline'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Pipelines
summary: Delete Pipeline
description: 'Delete a pipeline and all associated resources.
Removes pipeline files, data sources, and vector store data.
This operation is irreversible.'
operationId: delete_pipeline_api_v1_pipelines__pipeline_id__delete
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/status:
get:
tags:
- Pipelines
summary: Get Pipeline Status
description: 'Get the ingestion status of a managed pipeline.
Returns document counts, sync progress, and the last
effective timestamp. Only available for managed pipelines.'
operationId: get_pipeline_status_api_v1_pipelines__pipeline_id__status_get
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: full_details
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Full Details
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedIngestionStatusResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/sync:
post:
tags:
- Pipelines
summary: Sync Pipeline
description: 'Trigger an incremental sync for a managed pipeline.
Processes new and updated documents from data sources and
files, then updates the index for retrieval.'
operationId: sync_pipeline_api_v1_pipelines__pipeline_id__sync_post
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Pipeline'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/sync/cancel:
post:
tags:
- Pipelines
summary: Cancel Pipeline Sync
description: Cancel all running sync jobs for a pipeline.
operationId: cancel_pipeline_sync_api_v1_pipelines__pipeline_id__sync_cancel_post
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Pipeline'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/force-delete:
post:
tags:
- Pipelines
summary: Force Delete Pipeline
operationId: force_delete_pipeline_api_v1_pipelines__pipeline_id__force_delete_post
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/copy:
post:
tags:
- Pipelines
summary: Copy Pipeline
description: 'Copy a pipeline including its files and documents.
Creates a new pipeline with the same configuration and
triggers a sync to populate the new vector store.'
operationId: copy_pipeline_api_v1_pipelines__pipeline_id__copy_post
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Pipeline'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/retrieve:
post:
tags:
- Pipelines
summary: Run Search
description: 'Run a retrieval query against a managed pipeline.
Searches the pipeline''s vector store using the provided query
and retrieval parameters. Supports dense, sparse, and hybrid
search modes with configurable top-k and reranking.'
operationId: run_search_api_v1_pipelines__pipeline_id__retrieve_post
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RetrievalParams'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveResults'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/playground-session:
get:
tags:
- Pipelines
summary: Get Playground Session
description: Get a playground session for a user and pipeline.
operationId: get_playground_session_api_v1_pipelines__pipeline_id__playground_session_get
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PlaygroundSession'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/chat:
post:
tags:
- Pipelines
summary: Chat
description: 'Chat with a managed pipeline using RAG.
Combines retrieval from the pipeline''s vector store with an
LLM chat completion. Returns a streaming response.'
operationId: chat_api_v1_pipelines__pipeline_id__chat_post
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChatInputParams'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/documents:
post:
tags:
- Pipelines
summary: Create Batch Pipeline Documents
description: Batch create documents for a pipeline.
operationId: create_batch_pipeline_documents_api_v1_pipelines__pipeline_id__documents_post
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CloudDocumentCreate'
title: Documents
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CloudDocument'
title: Response Create Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Pipelines
summary: List Pipeline Documents
description: Return a list of documents for a pipeline.
operationId: list_pipeline_documents_api_v1_pipelines__pipeline_id__documents_get
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: skip
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Skip
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
default: 10
title: Limit
- name: file_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: File Id
- name: only_direct_upload
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Only Direct Upload
- name: only_api_data_source_documents
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Only Api Data Source Documents
- name: status_refresh_policy
in: query
required: false
schema:
enum:
- cached
- ttl
type: string
default: cached
title: Status Refresh Policy
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CloudDocument'
title: Response List Pipeline Documents Api V1 Pipelines Pipeline Id Documents Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Pipelines
summary: Upsert Batch Pipeline Documents
description: Batch create or update a document for a pipeline.
operationId: upsert_batch_pipeline_documents_api_v1_pipelines__pipeline_id__documents_put
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CloudDocumentCreate'
title: Documents
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CloudDocument'
title: Response Upsert Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Put
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/documents/paginated:
get:
tags:
- Pipelines
summary: Paginated List Pipeline Documents
description: Return a list of documents for a pipeline.
operationId: paginated_list_pipeline_documents_api_v1_pipelines__pipeline_id__documents_paginated_get
security:
- HTTPBearer: []
parameters:
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: skip
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Skip
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
default: 10
title: Limit
- name: file_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: File Id
- name: only_direct_upload
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Only Direct Upload
- name: only_api_data_source_documents
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Only Api Data Source Documents
- name: status_refresh_policy
in: query
required: false
schema:
enum:
- cached
- ttl
type: string
default: cached
title: Status Refresh Policy
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedListCloudDocumentsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/documents/{document_id}:
get:
tags:
- Pipelines
summary: Get Pipeline Document
description: Return a single document for a pipeline.
operationId: get_pipeline_document_api_v1_pipelines__pipeline_id__documents__document_id__get
security:
- HTTPBearer: []
parameters:
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDocument'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Pipelines
summary: Delete Pipeline Document
description: Delete a document from a pipeline; runs async (vectors first, then MongoDB record).
operationId: delete_pipeline_document_api_v1_pipelines__pipeline_id__documents__document_id__delete
security:
- HTTPBearer: []
parameters:
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status:
get:
tags:
- Pipelines
summary: Get Pipeline Document Status
description: Return a single document for a pipeline.
operationId: get_pipeline_document_status_api_v1_pipelines__pipeline_id__documents__document_id__status_get
security:
- HTTPBearer: []
parameters:
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedIngestionStatusResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/documents/{document_id}/sync:
post:
tags:
- Pipelines
summary: Sync Pipeline Document
description: Sync a specific document for a pipeline.
operationId: sync_pipeline_document_api_v1_pipelines__pipeline_id__documents__document_id__sync_post
security:
- HTTPBearer: []
parameters:
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/pipelines/{pipeline_id}/documents/{document_id}/chunks:
get:
tags:
- Pipelines
summary: List Pipeline Document Chunks
description: Return a list of chunks for a pipeline document.
operationId: list_pipeline_document_chunks_api_v1_pipelines__pipeline_id__documents__document_id__chunks_get
security:
- HTTPBearer: []
parameters:
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
- name: pipeline_id
in: path
required: true
schema:
type: string
format: uuid
title: Pipeline Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TextNode'
title: Response List Pipeline Document Chunks Api V1 Pipelines Pipeline Id Documents Document Id Chunks Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ChatMessage:
properties:
id:
type: string
format: uuid
title: Id
index:
type: integer
title: Index
description: The index of the message in the chat.
annotations:
items:
$ref: '#/components/schemas/MessageAnnotation'
type: array
title: Annotations
description: Retrieval annotations for the message.
role:
$ref: '#/components/schemas/MessageRole'
description: The role of the message.
content:
anyOf:
- type: string
- type: 'null'
title: Content
description: Text content of the generation
additional_kwargs:
additionalProperties:
type: string
type: object
title: Additional Kwargs
description: Additional argument
# --- truncated at 32 KB (142 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/llamaparse/refs/heads/main/openapi/llamaparse-pipelines-api-openapi.yml