Deepset

Deepset Pipeline API

The pipeline API from Deepset — 43 operation(s) for pipeline.

GitHub OpenAPI

Operations 53

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 #
GET /api/v1/workspaces/{workspace_name}/pipelines List Pipelines #
POST /api/v1/workspaces/{workspace_name}/pipelines Create 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 #
DELETE /api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name} Delete Pipeline #
GET /api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name} Get Pipeline #
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 #
POST /api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/deploy Deploy 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 Search #
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 #
POST /api/v1/workspaces/{workspace_name}/pipelines/{pipeline_name}/undeploy Undeploy Pipeline #
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 #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/deepset/refs/heads/main/openapi/deepset-pipeline-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/deepset:deepset-pipeline-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

deepset-pipeline-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: deepset API description
  title: Haystack Enterprise Platform Pipeline API
  version: 1.0.0
servers:
- description: deepset Europe
  url: https://api.cloud.deepset.ai
- description: deepset US
  url: https://api.us.deepset.ai
tags:


# --- truncated at 32 KB (232 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deepset/refs/heads/main/openapi/deepset-pipeline-api-openapi.yml