Pipeline Management

Instill VDP also provides a set of methods for pipeline management, including listing, updating, and deleting pipelines.

#Manage Pipelines via API

#Explore Pipelines

This endpoint returns a paginated list of pipelines that are visible to the requester.

cURL
Python

export INSTILL_API_TOKEN=********
curl -X GET 'https://api.instill.tech/v1beta/pipelines' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN"

#List Pipelines

This endpoint returns a paginated list of pipelines associated with a specific namespace.

cURL
Python

export INSTILL_API_TOKEN=********
curl -X GET 'https://api.instill.tech/v1beta/namespaces/NAMESPACE_ID/pipelines' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN"

#Get Pipeline

This endpoint allows for getting a pipeline.

cURL
Python

export INSTILL_API_TOKEN=********
curl -X GET 'https://api.instill.tech/v1beta/namespaces/NAMESPACE_ID/pipelines/PIPELINE_ID' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN"

#Update Pipeline

This endpoint allows for updating a pipeline with a new recipe.

cURL
Python

export INSTILL_API_TOKEN=********
curl -X PATCH 'https://api.instill.tech/v1beta/namespaces/NAMESPACE_ID/pipelines/PIPELINE_ID' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN" \
--data '{
"description": "A brief description of your pipeline",
"rawRecipe": "The YAML recipe of your pipeline"
}'

#Delete Pipeline

This endpoint enables the deletion of a specified pipeline.

cURL
Python

export INSTILL_API_TOKEN=********
curl -X DELETE 'https://api.instill.tech/v1beta/namespaces/NAMESPACE_ID/pipelines/PIPELINE_ID' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN"

The NAMESPACE_ID and PIPELINE_ID path parameter must be replaced by the pipeline owner's ID (namespace) and the pipeline ID.

For more details, please refer to the API Reference.

#Manage Pipelines via Console

#Explore Pipelines

  1. Launch Instill Console on Instill Cloud.
  2. Navigate to the Explore page.
  3. Instill Console will display all pipelines visible to the user.

#List Pipelines

  1. Launch Instill Console on Instill Cloud.
  2. Navigate to the Pipelines page via the navigation bar.
  3. Instill Console will list all pipelines within the selected namespace.

#Update Pipeline

The Instill Console features an auto-save capability, eliminating the need for manual saving of pipelines.

#Delete Pipeline

  1. On the Pipeline list page, right-click the "More Options" button.
  2. Select Delete to remove the pipeline.