Haystack / deepset

Haystack is deepset's open-source Python framework for building context-engineered, production-ready LLM applications - modular Pipelines and agent workflows assembled from 100+ Components and document stores for RAG, semantic search, and agents. Haystack pipelines deploy as REST services via Hayhooks, and the commercial deepset AI Platform (deepset Cloud) exposes a hosted REST API at api.cloud.deepset.ai for pipelines, search, files, and workspaces.

6 APIs 0 Features

AILLMRAGOpen SourceOrchestration

APIs

Haystack Framework (Open Source)

Apache-2.0 licensed Python framework for composable LLM orchestration. Build modular Pipelines from Components (retrievers, routers, embedders, generators, evaluators) over Docu...

Hayhooks REST Deployment

Hayhooks turns a Haystack pipeline into a self-hosted REST API (and optional MCP server) with one command, auto-generating OpenAPI/Swagger docs and HTTP run endpoints. The deplo...

deepset Cloud API - Pipelines

Hosted REST API to create, list, deploy, and undeploy Haystack pipelines inside a deepset Cloud workspace. Bearer-authenticated under /api/v1/workspaces/{workspace}/pipelines.

deepset Cloud API - Search

Runs queries against a deployed pipeline, returning answers and retrieved documents. POST /api/v1/workspaces/{workspace}/pipelines/{pipeline}/search with queries, filters, and r...

deepset Cloud API - Files

Uploads, lists, and deletes files in a workspace, updates file metadata, and manages chunked upload sessions for indexing into pipelines and indexes.

deepset Cloud API - Workspaces

Creates, lists, and deletes workspaces - the isolation boundary that holds a deepset Cloud account's pipelines and data. Pipelines and data are not shared across workspaces.

Collections

deepset Cloud API (deepset AI Platform)

OPEN

Pricing Plans

Haystack Ai Plans Pricing

2 plans

PLANS

Rate Limits

Haystack Ai Rate Limits

5 limits

RATE LIMITS

FinOps

Haystack Ai Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: deepset Cloud API (deepset AI Platform)
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Workspaces
    type: folder
  items:
  - info:
      name: List workspaces
      type: http
    http:
      method: GET
      url: https://api.cloud.deepset.ai/api/v1/workspaces
    docs: Returns the workspaces available to the authenticated organization.
  - info:
      name: Create a workspace
      type: http
    http:
      method: POST
      url: https://api.cloud.deepset.ai/api/v1/workspaces
      body:
        type: json
        data: "{\n  \"name\": \"my-workspace\"\n}"
    docs: Creates a workspace that isolates pipelines and data.
  - info:
      name: Get a workspace
      type: http
    http:
      method: GET
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}
    docs: Returns a single workspace.
  - info:
      name: Delete a workspace
      type: http
    http:
      method: DELETE
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}
    docs: Deletes a workspace and its contents.
- info:
    name: Pipelines
    type: folder
  items:
  - info:
      name: List pipelines
      type: http
    http:
      method: GET
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/pipelines
    docs: Lists pipelines in the workspace.
  - info:
      name: Create a pipeline
      type: http
    http:
      method: POST
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/pipelines
      body:
        type: text
        data: <binary Haystack pipeline YAML>
    docs: Creates a pipeline from a Haystack pipeline YAML definition.
  - info:
      name: Get a pipeline
      type: http
    http:
      method: GET
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/pipelines/{{pipeline_name}}
    docs: Returns a single pipeline.
  - info:
      name: Delete a pipeline
      type: http
    http:
      method: DELETE
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/pipelines/{{pipeline_name}}
    docs: Deletes a pipeline.
  - info:
      name: Deploy a pipeline
      type: http
    http:
      method: POST
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/pipelines/{{pipeline_name}}/deploy
    docs: Deploys the pipeline so it can serve search requests.
  - info:
      name: Undeploy a pipeline
      type: http
    http:
      method: POST
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/pipelines/{{pipeline_name}}/undeploy
    docs: Undeploys the pipeline.
- info:
    name: Search
    type: folder
  items:
  - info:
      name: Run a search
      type: http
    http:
      method: POST
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/pipelines/{{pipeline_name}}/search
      body:
        type: json
        data: "{\n  \"queries\": [\"my query\"],\n  \"filters\": {\n    \"field\": \"meta.field_name\",\n    \"operator\"\
          : \"==\",\n    \"value\": \"field_value\"\n  },\n  \"params\": {},\n  \"debug\": false\n}"
    docs: Runs queries against a deployed pipeline and returns answers and documents.
- info:
    name: Files
    type: folder
  items:
  - info:
      name: List files
      type: http
    http:
      method: GET
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/files
    docs: Lists files in the workspace.
  - info:
      name: Upload a file
      type: http
    http:
      method: POST
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/files?write_mode=OVERWRITE
      body:
        type: text
        data: <multipart/form-data file + meta>
    docs: Uploads a file into the workspace for indexing.
  - info:
      name: Delete a file
      type: http
    http:
      method: DELETE
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/files/{{file_id}}
    docs: Deletes a file.
  - info:
      name: Update file metadata
      type: http
    http:
      method: PATCH
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/files/{{file_id}}/meta
      body:
        type: json
        data: "{\n  \"key\": \"value\"\n}"
    docs: Updates metadata on a file.
  - info:
      name: Create an upload session
      type: http
    http:
      method: POST
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/upload_sessions
    docs: Opens a session for chunked uploads of many files.
  - info:
      name: Get upload session details
      type: http
    http:
      method: GET
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/upload_sessions/{{session_id}}
    docs: Returns the status and details of an upload session.
  - info:
      name: Close an upload session
      type: http
    http:
      method: PUT
      url: https://api.cloud.deepset.ai/api/v1/workspaces/{{workspace_name}}/upload_sessions/{{session_id}}
      body:
        type: json
        data: "{\n  \"status\": \"CLOSED\"\n}"
    docs: Closes an upload session.