Skip to main content
For the complete documentation index for agents and LLMs, see llms.txt.

Edit a Pipeline

Improve your pipeline to make your search faster and more accurate. You can edit pipelines in Pipeline Builder or through REST API.

About This Task​

You can edit a development pipeline while it remains deployed. You can make the following changes:

  • Update query pipeline components, except for the embedding model and its format.
  • Update the index a pipeline is using.
  • Update the pipeline's name.

You can't modify or add and remove components, or change their order without undeploying the pipeline first.

Production Pipelines

You can't edit production pipelines. You must change the pipeline's service level first.

One Editor at a Time​

Only one person can edit a pipeline at a time. When someone saves changes, the pipeline is locked for 60 seconds so others cannot overwrite the same version.

  • If you try to edit while the pipeline is locked: You see a message like "[User A] edited this pipeline 30 seconds ago. You can edit in 30 seconds."
  • After 60 seconds: The lock expires. Click Try again to start editing.
  • Why 60 seconds? The lock prevents situations where people rapidly overwrite each other's changes, while still allowing sequential collaboration.

The lock is based on time (60 seconds after the last save), not on whether the other person has the editor open. If someone leaves their browser open without saving, you can edit after 60 seconds from their last save.

Need to Edit at the Same Time?

If you often need multiple people to edit a pipeline at once, share your use case with us. We're tracking this to inform future collaboration features.

Prerequisites​

  • You must be an Admin to perform this task.
  • If the changes you want to make require undeploying the pipeline, go to Pipelines, click the more actions button next to the pipeline name, and select Undeploy.
  • If you're updating the index the pipeline uses, make sure the index is enabled. For instructions, see Enable an Index.
  • To edit pipelines using API endpoints, generate an API Key first.

Edit a Pipeline in Pipeline Builder​

This is the default way of editing pipelines. It opens the pipeline in the visual editor. You can use it to replace one component with another or update the parameters quickly.

  1. Log in to Haystack Enterprise Platform and go to Pipelines.

  2. Find the pipeline you want to edit, click the More Actions menu next to it, and choose Edit.

    The three dots menu expanded with the Edit option underlined.
    Renaming a Pipeline

    If you just want to rename a pipeline, you can do it from the More Actions menu without opening the Builder. Click More Actions next to a pipeline and choose Rename.

  3. Modify the pipeline and save it.

    Update Index

    To update an index a pipeline is using, find the document store that uses the index you want to change and choose a different index.

  4. Deploy the pipeline to use it for search.

Edit a Pipeline with REST API​

Update Pipeline Settings​

Use the Update Pipeline endpoint to change pipeline settings, such as name or service level, without changing the YAML configuration.

Example​

Copy this code and modify it as needed:

     --request PATCH \
     --url https://api.cloud.deepset.ai/api/v1/<YOUR_WORKSPACE>/pipelines/<YOUR_PIPELINE_NAME> \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "name": "new_pipeline_name",
  "service_level": "DEVELOPMENT",
  "status": 1
}
'

Update Pipeline YAML Configuration​

For updating pipeline YAML configuration, use the pipeline versions API:

  1. Fetch the latest version using Get Query Pipeline Version.
  2. If the latest version is not a draft, create a new version with Create Query Pipeline Version.
  3. Update the pipeline configuration using Path Query Pipeline Version.