{ "opencollection": "1.0.0", "info": { "name": "Llama Platform Agent Data Pipelines API", "version": "0.1.0" }, "items": [ { "info": { "name": "Pipelines", "type": "folder" }, "items": [ { "info": { "name": "Search Pipelines", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/pipelines", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "project_name", "value": "", "type": "query" }, { "name": "pipeline_name", "value": "", "type": "query" }, { "name": "pipeline_type", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search for pipelines by name, type, or project." }, { "info": { "name": "Create Pipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/pipelines", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new managed ingestion pipeline.\n\nA pipeline connects data sources to a vector store for RAG.\nAfter creation, call `POST /pipelines/{id}/sync` to start\ningesting documents." }, { "info": { "name": "Upsert Pipeline", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/pipelines", "params": [ { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upsert a pipeline.\n\nUpdates the pipeline if one with the same name and project\nalready exists, otherwise creates a new one." }, { "info": { "name": "Get Pipeline", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a pipeline by ID." }, { "info": { "name": "Update Existing Pipeline", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing pipeline's configuration." }, { "info": { "name": "Delete Pipeline", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a pipeline and all associated resources.\n\nRemoves pipeline files, data sources, and vector store data.\nThis operation is irreversible." }, { "info": { "name": "Get Pipeline Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/status", "params": [ { "name": "pipeline_id", "value": "", "type": "path" }, { "name": "full_details", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the ingestion status of a managed pipeline.\n\nReturns document counts, sync progress, and the last\neffective timestamp. Only available for managed pipelines." }, { "info": { "name": "Sync Pipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/sync", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Trigger an incremental sync for a managed pipeline.\n\nProcesses new and updated documents from data sources and\nfiles, then updates the index for retrieval." }, { "info": { "name": "Cancel Pipeline Sync", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/sync/cancel", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel all running sync jobs for a pipeline." }, { "info": { "name": "Force Delete Pipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/force-delete", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Force Delete Pipeline" }, { "info": { "name": "Copy Pipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/copy", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Copy a pipeline including its files and documents.\n\nCreates a new pipeline with the same configuration and\ntriggers a sync to populate the new vector store." }, { "info": { "name": "Run Search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/retrieve", "params": [ { "name": "pipeline_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Run a retrieval query against a managed pipeline.\n\nSearches the pipeline's vector store using the provided query\nand retrieval parameters. Supports dense, sparse, and hybrid\nsearch modes with configurable top-k and reranking." }, { "info": { "name": "Get Playground Session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/playground-session", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a playground session for a user and pipeline." }, { "info": { "name": "Chat", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/chat", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Chat with a managed pipeline using RAG.\n\nCombines retrieval from the pipeline's vector store with an\nLLM chat completion. Returns a streaming response." }, { "info": { "name": "List Pipeline Documents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/documents", "params": [ { "name": "pipeline_id", "value": "", "type": "path" }, { "name": "skip", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "file_id", "value": "", "type": "query" }, { "name": "only_direct_upload", "value": "", "type": "query" }, { "name": "only_api_data_source_documents", "value": "", "type": "query" }, { "name": "status_refresh_policy", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return a list of documents for a pipeline." }, { "info": { "name": "Create Batch Pipeline Documents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/documents", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Batch create documents for a pipeline." }, { "info": { "name": "Upsert Batch Pipeline Documents", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/documents", "params": [ { "name": "pipeline_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Batch create or update a document for a pipeline." }, { "info": { "name": "Paginated List Pipeline Documents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/documents/paginated", "params": [ { "name": "pipeline_id", "value": "", "type": "path" }, { "name": "skip", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "file_id", "value": "", "type": "query" }, { "name": "only_direct_upload", "value": "", "type": "query" }, { "name": "only_api_data_source_documents", "value": "", "type": "query" }, { "name": "status_refresh_policy", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return a list of documents for a pipeline." }, { "info": { "name": "Get Pipeline Document", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/documents/:document_id", "params": [ { "name": "document_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return a single document for a pipeline." }, { "info": { "name": "Delete Pipeline Document", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/documents/:document_id", "params": [ { "name": "document_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a document from a pipeline; runs async (vectors first, then MongoDB record)." }, { "info": { "name": "Get Pipeline Document Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/documents/:document_id/status", "params": [ { "name": "document_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return a single document for a pipeline." }, { "info": { "name": "Sync Pipeline Document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/documents/:document_id/sync", "params": [ { "name": "document_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Sync a specific document for a pipeline." }, { "info": { "name": "List Pipeline Document Chunks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/pipelines/:pipeline_id/documents/:document_id/chunks", "params": [ { "name": "document_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return a list of chunks for a pipeline document." } ] } ], "bundled": true }