Pipelines

Sync Pipeline

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

Path parameters

pipeline_idstring uuid required

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_events": [
          "parse.success",
          "parse.error"
        ],
        "webhook_output_format": "json"
      }
    ]
  }
}

Changes

Changed in 2 of the 33 revisions of this API.62

Jun 9, 2026b17341164de92See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 4, 2026d40e17e17bd16See the full diff
- ●
  added the new classify.running enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new sheets.cancelled enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new sheets.error enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new sheets.partial_success enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new sheets.pending enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new sheets.success enum value to the /////// response property for the response status
  response-property-enum-value-added

Full history