Skip to content

Sync Index

client.beta.indexes.sync(stringindexID, IndexSyncParams { organization_id, project_id } params?, RequestOptionsoptions?): IndexSyncResponse
POST/api/v1/indexes/{index_id}/sync

Trigger a sync and export for an existing index, re-parsing changed files and exporting updated chunks.

ParametersExpand Collapse
indexID: string
params: IndexSyncParams { organization_id, project_id }
organization_id?: string | null
project_id?: string | null
ReturnsExpand Collapse
IndexSyncResponse = unknown

Sync Index

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.beta.indexes.sync('index_id');

console.log(response);
{}
Returns Examples
{}