Skip to content

Sync Pipeline Document

Deprecated
JsonValue pipelines().documents().sync(DocumentSyncParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/pipelines/{pipeline_id}/documents/{document_id}/sync

Sync a specific document for a pipeline.

ParametersExpand Collapse
DocumentSyncParams params
String pipelineId
Optional<String> documentId
ReturnsExpand Collapse
class DocumentSyncResponse:

Sync Pipeline Document

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.pipelines.documents.DocumentSyncParams;
import com.llamacloud_prod.api.models.pipelines.documents.DocumentSyncResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        DocumentSyncParams params = DocumentSyncParams.builder()
            .pipelineId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .documentId("document_id")
            .build();
        DocumentSyncResponse response = client.pipelines().documents().sync(params);
    }
}
{}
Returns Examples
{}
Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/