Update a pipeline
PATCH/pipelines/:pipeline_id
Changes the name, description, default text splitter or metadata schema of a pipeline. The embedding model, the full-text search setting and the classifications cannot be changed through this operation. The response body shows the pipeline as it was before the change, so a client application reads the pipeline with GET /pipelines/{pipeline_id} to confirm the new values.
Permissions. Write on the pipeline.
Settings that can change explains why a client sends every change to a pipeline in one request.
Request
Responses
- 200
- 401
- 403
- 404
- 409
The pipeline was updated. The body is the pipeline as it was before the change.
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
The license does not allow the change (Invalid license).
No pipeline with this identifier exists, or the key lacks write permission on the pipeline (Pipeline not found).
The new name is already in use, or the request names a text splitter that does not exist (Conflict unique error or Conflict related error).