API Reference

Pipelines

Documents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Sync Pipeline Document

Deprecated

client.pipelines.documents.sync(stringdocumentID, DocumentSyncParams { pipeline_id } params, RequestOptionsoptions?): DocumentSyncResponse

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

Sync a specific document for a pipeline.

ParametersExpand Collapse

documentID: string

params: DocumentSyncParams { pipeline_id }

pipeline_id: string

ReturnsExpand Collapse

DocumentSyncResponse = unknown

Sync Pipeline Document

TypeScript

HTTP

TypeScript

Python

Java

Go

CLI Tool

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.pipelines.documents.sync('document_id', {
  pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(response);

200 example

{}

Returns Examples

200 example

{}