# Instill AI Pipeline API

**Canonical:** https://apis.io/apis/instill-ai/instill-ai-pipeline-api/  
**Provider:** Instill AI — https://apis.io/providers/instill-ai/  
**Base URL:** https://api.instill-ai.com  
**Documentation:** https://docs.instill-ai.com/reference

Instill AI Pipeline API is one of 7 APIs that [Instill AI](https://apis.io/providers/instill-ai/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Pipeline. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

Pipeline orchestration.

## Operations (30)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/v1beta/{name_2}` | Delete a pipeline |
| GET | `/v1beta/pipelines` | List accessible pipelines |
| GET | `/v1beta/{parent}/pipelines` | List namespace pipelines |
| POST | `/v1beta/{parent}/pipelines` | Create a new pipeline |
| GET | `/v1beta/{name_3}` | Get a pipeline |
| DELETE | `/v1beta/{name_3}` | Delete a pipeline release |
| PATCH | `/v1beta/{pipeline.name}` | Update a pipeline |
| POST | `/v1beta/{name}/validate` | Validate a pipeline |
| POST | `/v1beta/{name}/rename` | Rename a pipeline |
| POST | `/v1beta/{name}/clone` | Clone a pipeline |
| POST | `/v1beta/{name}/trigger` | Trigger a pipeline |
| POST | `/v1beta/{name}/trigger-stream` | Trigger a pipeline via streaming |
| POST | `/v1beta/{name}/trigger-async` | Trigger a pipeline asynchronously |
| GET | `/v1beta/{parent}/releases` | List the releases in a pipeline |
| POST | `/v1beta/{parent}/releases` | Create a pipeline release |
| GET | `/v1beta/{name_4}` | Get a pipeline release |
| DELETE | `/v1beta/{name_4}` | Delete a secret |
| PATCH | `/v1beta/{release.name}` | Update a pipeline release |
| POST | `/v1beta/{name_1}/clone` | Clone a pipeline release |
| POST | `/v1beta/{name_1}/trigger` | Trigger a pipeline release |
| POST | `/v1beta/{name_1}/trigger-async` | Trigger a pipeline release asynchronously |
| GET | `/v1beta/{parent}/secrets` | List secrets |
| POST | `/v1beta/{parent}/secrets` | Create a secret |
| GET | `/v1beta/{name_5}` | Get a secret |
| PATCH | `/v1beta/{secret.name}` | Update a secret |
| GET | `/v1beta/component-definitions` | List component definitions |
| GET | `/v1beta/operations/{operationId}` | Get the details of a long-running operation |
| GET | `/v1beta/{parent}/runs` | List Pipeline Runs |
| GET | `/v1beta/{parent}/component-runs` | List Component Runs |
| GET | `/v1beta/dashboard/pipelines/runs` | List Pipeline Runs By Requester |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/instill-ai/refs/heads/main/openapi/instill-ai-pipeline-api-openapi.yml
- **Protobuf** — https://raw.githubusercontent.com/api-evangelist/instill-ai/refs/heads/main/grpc/instill-ai-pipeline-v1beta-pipeline_public_service.proto
- **Protobuf** — https://raw.githubusercontent.com/api-evangelist/instill-ai/refs/heads/main/grpc/instill-ai-mgmt-v1beta-mgmt_public_service.proto
- **Protobuf** — https://raw.githubusercontent.com/api-evangelist/instill-ai/refs/heads/main/grpc/instill-ai-model-v1alpha-model_public_service.proto
- **Protobuf** — https://raw.githubusercontent.com/api-evangelist/instill-ai/refs/heads/main/grpc/instill-ai-artifact-v1alpha-artifact_public_service.proto
- **Protobuf** — https://raw.githubusercontent.com/api-evangelist/instill-ai/refs/heads/main/grpc/instill-ai-usage-v1beta-usage_service.proto
- **Documentation** — https://docs.instill-ai.com/reference

## Other Instill AI APIs (6)

- [Instill AI Artifact API](https://apis.io/apis/instill-ai/instill-ai-artifact-api/)
- [Instill AI Connection API](https://apis.io/apis/instill-ai/instill-ai-connection-api/)
- [Instill AI Integration API](https://apis.io/apis/instill-ai/instill-ai-integration-api/)
- [Instill AI Metrics API](https://apis.io/apis/instill-ai/instill-ai-metrics-api/)
- [Instill AI Model API](https://apis.io/apis/instill-ai/instill-ai-model-api/)
- [Instill AI Namespace API](https://apis.io/apis/instill-ai/instill-ai-namespace-api/)

## Tags

Pipeline

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/instill-ai/instill-ai-pipeline-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/instill-ai/.