Skip to content
Get started

Sync Pipeline Document

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

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);
{}
Returns Examples
{}