Skip to main content

Update a pipeline

PATCH 

/pipelines/:pipeline_id

Changes the name, description, default text splitter or metadata schema of a pipeline. Fields that the request omits keep their values, and "description": null clears the description. A new default text splitter applies to the documents submitted after the change. Search indexes and classifications are not changed through this operation: a request with an index field, or any other unknown field, returns HTTP 422, the operations under /pipelines/{pipeline_id}/search-indexers add, switch and remove indexes, and POST /pipelines/{pipeline_id}/classifications changes the classifications. The response body is the pipeline with the new settings.

Permissions. Write on the pipeline and, for a new default text splitter, write on that text splitter.

Settings that can change explains why a client sends every change to a pipeline in one request.

Request​

Responses​

The pipeline was updated. The body is the pipeline with the new settings.