v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-09194386949.7 KB
Pipelines

Create Pipeline

Create a new managed ingestion pipeline.

A pipeline connects data sources to a vector store for RAG. After creation, call POST /pipelines/{id}/sync to start ingesting documents.

post/api/v1/pipelines

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

data_sink_idstring uuid nullable

Data sink ID. When provided instead of data_sink, the data sink will be looked up by ID.

embedding_model_config_idstring uuid nullable

Embedding model config ID. When provided instead of embedding_config, the embedding model config will be looked up by ID.

statusstring nullable

Status of the pipeline deployment.

namestring required
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.

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.