# Haystack / deepset Pipeline API

**Canonical:** https://apis.io/apis/haystack-ai/haystack-ai-pipeline-api/  
**Provider:** Haystack / deepset — https://apis.io/providers/haystack-ai/  
**Base URL:** https://api.cloud.deepset.ai  
**Documentation:** https://docs.haystack.deepset.ai/docs/intro

Haystack / deepset Pipeline API is one of 42 APIs that [Haystack / deepset](https://apis.io/providers/haystack-ai/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Pipelines. The published artifact set on APIs.io includes an OpenAPI specification.

The Pipeline API from Haystack / deepset — 39 operation(s) for pipeline.

## Operations (46)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/workspaces/{workspace_name}/pipeline-tags` | List Pipeline Tags |
| GET | `/api/v1/workspaces/{workspace_name}/pipeline/versions` | List all query pipeline versions in a workspace |
| POST | `/api/v1/workspaces/{workspace_name}/pipeline_validations` | Validate Pipeline |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/apply-migrations` | Apply Pipeline Migrations |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/detect-migrations` | Detect Pipeline Migrations |
| PATCH | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}` | Update Pipeline |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/activate` | Activate Pipeline |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/chat` | Chat |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/chat-stream` | Chat Stream |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/default` | Set Default Pipeline |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/issues` | Get Pipeline Issues |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/logs` | Get Pipeline Logs |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/meta` | Get Pipeline Index Metadata Types |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/meta/{field_name}` | Get Pipeline Metadata Field Values |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/meta/{meta_field}/aggregation` | Get Pipeline Min Max Aggregation Metadata |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/migrations` | List Migrations |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/migrations/{job_id}` | Get Migration By Id |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/prompt` | Get Prompt |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/prompts` | Get Prompts |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/search-stream` | Search Stream |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/search_history` | Pipeline Search History |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/search_history_archive` | Pipeline Search History Archive |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/stats` | Get Pipeline Stats |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/tags` | Add Pipeline Tag |
| DELETE | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/tags/{tag_name}` | Delete Pipeline Tag |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/versions` | List Query Pipeline Versions |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/versions` | Create Query Pipeline Version |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/versions/{version_id}` | Get Query Pipeline Version |
| PATCH | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/versions/{version_id}` | Patch Query Pipeline Version |
| POST | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/versions/{version_id}/restore` | Restore Pipeline Version |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/versions/{version_id}/visualization` | Get Query Pipeline Version Visualization |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/visualization` | Get Pipeline Visualization |
| PUT | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/visualization` | Update Pipeline Visualization |
| GET | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/yaml` | Get Pipeline Yaml Configs |
| PUT | `/api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/yaml` | Update Pipeline Yaml |
| DELETE | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history` | Delete Pipeline Search History |
| DELETE | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history/bulk/labels` | Bulk Unassign Search History Labels |
| PUT | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history/bulk/labels` | Bulk Assign Search History Labels |
| GET | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history/labels` | Get Search History Labels |
| DELETE | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history/labels/{label_name}` | Delete Search History Label |
| GET | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history/{query_id}` | Pipeline Search History Result |
| DELETE | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history/{query_id}/labels` | Unassign Search History Labels |
| PUT | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history/{query_id}/labels` | Assign Search History Labels |
| DELETE | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history/{query_id}/note` | Clear Search History Note |
| PUT | `/api/v2/workspaces/{workspace_id}/pipelines/{pipeline_id}/search_history/{query_id}/note` | Set Search History Note |
| DELETE | `/api/v2/workspaces/{workspace_id}/users/{user_id}/search_history` | Delete User Search History |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/haystack-ai/openapi/haystack-ai-pipeline-api-openapi.yml

## Other Haystack / deepset APIs (12)

- [Haystack Framework (Open Source)](https://apis.io/apis/haystack-ai/haystack-framework/)
- [Hayhooks REST Deployment](https://apis.io/apis/haystack-ai/hayhooks-rest-deployment/)
- [Haystack / deepset Files API](https://apis.io/apis/haystack-ai/haystack-ai-files-api/)
- [Haystack / deepset Pipelines API](https://apis.io/apis/haystack-ai/haystack-ai-pipelines-api/)
- [Haystack / deepset Search API](https://apis.io/apis/haystack-ai/haystack-ai-search-api/)
- [Haystack / deepset Workspaces API](https://apis.io/apis/haystack-ai/haystack-ai-workspaces-api/)
- [Haystack / deepset Config API](https://apis.io/apis/haystack-ai/haystack-ai-config-api/)
- [Haystack / deepset Dashboard API](https://apis.io/apis/haystack-ai/haystack-ai-dashboard-api/)
- [Haystack / deepset Openai API](https://apis.io/apis/haystack-ai/haystack-ai-openai-api/)
- [Haystack / deepset Status API](https://apis.io/apis/haystack-ai/haystack-ai-status-api/)
- [Haystack / deepset API Token API](https://apis.io/apis/haystack-ai/haystack-ai-api-token-api/)
- [Haystack / deepset Custom Components API](https://apis.io/apis/haystack-ai/haystack-ai-custom-components-api/)

## Tags

Pipelines

---

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