Pipelines

Sync Pipeline

Changed on

Trigger an incremental sync for a managed pipeline.

Processes new and updated documents from data sources and files, then updates the index for retrieval.

post/api/v1/pipelines/{pipeline_id}/sync

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/pipelines/{pipeline_id}/sync
  • Auth: HTTP bearer

Path parameters

pipeline_idstring uuid required

Query parameters

project_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring uuid required

Unique identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

namestring required
project_idstring uuid required
embedding_model_config_idstring uuid nullable

The ID of the EmbeddingModelConfig this pipeline is using.

pipeline_type'PLAYGROUND' | 'MANAGED'

Enum for representing the type of a pipeline

managed_pipeline_idstring uuid nullable

The ID of the ManagedPipeline this playground pipeline is linked to.

status'CREATED' | 'DELETING' nullable

Status of the pipeline.

Example response

{
  "llama_parse_parameters": {
    "webhook_configurations": [
      {
        "webhook_url": "https://example.com/webhooks/llamacloud",
        "webhook_headers": {
          "Authorization": "Bearer sk-..."
        },
        "webhook_signing_secret": "whsec_...",
        "webhook_events": [
          "parse.success",
          "parse.error"
        ],
        "webhook_output_format": "json"
      }
    ]
  }
}

Changes

  • a38b684f8e1bRevision changes
    • warning

      added the new batch.cancelled enum value to the /////// response property for the response status

    • warning

      added the new batch.error enum value to the /////// response property for the response status

    • warning

      added the new batch.pending enum value to the /////// response property for the response status

    • warning

      added the new batch.running enum value to the /////// response property for the response status

    • warning

      added the new batch.success enum value to the /////// response property for the response status

    • warning

      added the new classify.running enum value to the /////// response property for the response status

    • warning

      added the new sheets.cancelled enum value to the /////// response property for the response status

    • warning

      added the new sheets.error enum value to the /////// response property for the response status

    • warning

      added the new sheets.partial_success enum value to the /////// response property for the response status

    • warning

      added the new sheets.pending enum value to the /////// response property for the response status

    • warning

      added the new sheets.success enum value to the /////// response property for the response status

    • warning

      added the new split.cancelled enum value to the /////// response property for the response status

    • warning

      added the new split.error enum value to the /////// response property for the response status

    • warning

      added the new split.pending enum value to the /////// response property for the response status

    • warning

      added the new split.processing enum value to the /////// response property for the response status

    • warning

      added the new split.success enum value to the /////// response property for the response status

    • warning

      added the new verify.cancelled enum value to the /////// response property for the response status

    • warning

      added the new verify.error enum value to the /////// response property for the response status

    • warning

      added the new verify.pending enum value to the /////// response property for the response status

    • warning

      added the new verify.running enum value to the /////// response property for the response status

    • warning

      added the new verify.success enum value to the /////// response property for the response status

    • info

      endpoint deprecated

    • info

      added the new optional query request parameter project_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      removed the classify.running enum value from the /////// response property for the response status

    • info

      removed the sheets.cancelled enum value from the /////// response property for the response status

    • info

      removed the sheets.error enum value from the /////// response property for the response status

    • info

      removed the sheets.partial_success enum value from the /////// response property for the response status

    • info

      removed the sheets.pending enum value from the /////// response property for the response status

    • info

      removed the sheets.success enum value from the /////// response property for the response status