Create a pipeline
POST/pipelines
Creates a pipeline. The embedding model and the full-text search setting are fixed at creation and cannot change afterwards. The request names the classifications the pipeline defines and an optional metadata schema. The response body is the new pipeline.
Permissions. Write on the pipelines object type. Creating a pipeline also requires write on the text splitter named in the request, and write on the embedding model when the request names one.
See Pipelines.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 409
- 422
The pipeline was created. The body is the new pipeline.
The metadata schema in the request is not a valid schema (Schema error).
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
The key lacks write permission on the pipelines object type, or the license does not allow another pipeline (Invalid license or License limits exceeded for Pipeline).
The request names a text splitter or embedding model that does not exist, or that the key cannot use (Text Splitter not found or Embedding Model with id <id> not found).
A pipeline with this name already exists (Conflict unique error).
A required field such as name, default_text_splitter_id or classifications is missing, or a field has the wrong type. The response body is plain text and names the field (Failed to deserialize the JSON body into the target type: missing field ...).