Sign in
Pipelines

Update Existing Pipeline

Changed on

Update an existing pipeline for a project.

put/api/v1/pipelines/{pipeline_id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

pipeline_idstring uuid required

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 nullable
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.

Changes

  • 7a98f91d4000Revision changes
    • ●

      removed the request property

    • ●

      removed the optional property from the response with the status

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      the request property default value changed from auto to bm25

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      the response's property default value changed from auto to bm25 for the status

  • d8e4a921c2deRevision changes
    • ●

      removed the request property //

    • ●

      removed the optional property // from the response with the status

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status