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.

Haystack / deepset publishes 42 API contracts indexed on the APIs.io network, including Files API, Pipelines API, Search API, and 39 more. Tagged areas include Artificial Intelligence, LLM, RAG, Open Source, and Orchestration.

The Haystack / deepset catalog on APIs.io includes 1 Spectral governance ruleset.

Haystack / deepset’s developer surface includes authentication, documentation, engineering blog, and 10 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

32.5/100 thin ▬ flat Agent 47/100 agent native Front door AI 6/6 dominant Heartbeat 74/100 alive saas Full breakdown ↓
scored 2026-11-13 · rubric v0.28.0 · Show this score on your site →

AccessFreemiumSelf serve⚡ Free to try

5 published contracts 1 MCP Servers

Artificial Intelligence LLM RAG Open Source Orchestration

What this lets a business do 8

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

AI Model Services

AE-110

DeploymentsPipelineindexes

GET /api/v1/workspaces/{workspace_name}/deployments POST /api/v1/workspaces/{workspace_name}/deployments POST /api/v1/workspaces/{workspace_name}/deployments/v1/chat/completions

Information & Data Management

BC-610

ModelOpenaiPipelines

POST /api/v2/models/custom GET /v1/models POST /v1/chat/completions

Agent Infrastructure & Agentic Commerce

AE-100

MCPTools

GET /api/v2/workspaces/{workspace_id}/mcp/config GET /api/v2/workspaces/{workspace_id}/mcp/config/pipelines POST /api/v2/tool/parse

Software Release & Deployment Management

BC-4210

ConfigSecrets

POST /api/v2/secrets DELETE /api/v2/secrets-integrations/{provider} POST /deploy-yaml POST /deploy_files

Cybersecurity Management

BC-620

Userorganization_roles

POST /api/v1/users/{user_id}/roles POST /api/v1/users/{user_id}/unassign GET /api/v1/organization/{organization_id}/roles POST /api/v1/organization/{organization_id}/roles

Developer Platform & API Ecosystem Management

BC-4270

api_token

POST /api/v1/token

SaaS Platform Operations Management

BC-4220

Dashboard

GET /dashboard/api/traces GET /dashboard/api/traces/stream

SaaS Tenant Management

BC-4230

sso_connections

Kin Score

Kin Score How this is scored →
scored 2026-11-13 · rubric v0.28.0

Composite quality — 32.5/100 · thin

Contract Quality 9.5 / 19

Developer Ergonomics 6.6 / 15

Access Clarity 0.6 / 15

Operational Transparency 1.2 / 10

Contract Governance 1.2 / 9

Discoverability 6.0 / 8

Regulatory Posture 0.8 / 15

Create-or-Update Ergonomics 1.1 / 10

Agent readiness — 47/100 · agent native

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 6 / 6

MCP Server 12 / 12

Machine-Readable Auth 10 / 10

Idempotency 9 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/haystack-ai/"><img src="https://apis.io/badge/haystack-ai/card.svg" alt="Haystack / deepset on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0 Ask about this →
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document Ask about this →
Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented) Ask about this →
Typed Event Surface +6 pts — AsyncAPI document, OR webhooks/callbacks objects in the as-published OpenAPI, OR common[].type includes Webhooks Ask about this →
Agent Skills +5 pts — skills artifact present, graded by who authored it Ask about this →
Protected Resource Metadata +5 pts — a served /.well-known/oauth-protected-resource carrying `resource` (documented), and naming its authorization_servers (verified) Ask about this →

4 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 4.3 — up to +19.1 composite points Ask about this →
Contract Quality scores 50.8 — up to +12.3 composite points Ask about this →
Operational Transparency scores 11.9 — up to +11.5 composite points Ask about this →

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Not sure how this applies to your stack? Ask about any one item. Kin Lane reads every question, looks at your profile and your situation, and replies with what a fix would take — scoped to that one area, priced up front, yours whether you ship it or not. Ask a question →

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/haystack-ai/apis.yml: open an issue on github.com/api-evangelist/haystack-ai to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Cloud Native (Kubernetes, CNCF, FinOps)	standard	58.1	-	1
OpenSSF Best Practices Badge Holders	standard	58.1	-	1

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 2

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

Model Context Protocol (MCP)

measured — observed by APIs.io (verified)

OpenAPI

measured — observed by APIs.io (published)

APIs 42

Individual APIs this provider publishes, each with its own machine-readable definition.

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...

Haystack / deepset Files API

Upload, list, delete, and annotate files; manage upload sessions.

Haystack / deepset Pipelines API

Create, list, deploy, and undeploy Haystack pipelines.

Haystack / deepset Search API

Run queries against deployed pipelines.

Haystack / deepset Workspaces API

Manage workspaces that isolate pipelines and data.

Haystack / deepset Config API

The config API from Haystack / deepset — 4 operation(s) for config.

Haystack / deepset Dashboard API

The dashboard API from Haystack / deepset — 5 operation(s) for dashboard.

Haystack / deepset Openai API

The openai API from Haystack / deepset — 8 operation(s) for openai.

Haystack / deepset Status API

The status API from Haystack / deepset — 2 operation(s) for status.

Haystack / deepset API Token API

The api_token API from Haystack / deepset — 4 operation(s) for api_token.

Haystack / deepset Custom Components API

The custom_components API from Haystack / deepset — 3 operation(s) for custom_components.

Haystack / deepset Datasets API

The Datasets API from Haystack / deepset — 2 operation(s) for datasets.

Haystack / deepset Debug Tunnel API

The debug_tunnel API from Haystack / deepset — 1 operation(s) for debug_tunnel.

Haystack / deepset Deployments API

The Deployments API from Haystack / deepset — 19 operation(s) for deployments.

Haystack / deepset Feedback API

The Feedback API from Haystack / deepset — 4 operation(s) for feedback.

Haystack / deepset Feedback Tags API

The feedback_tags API from Haystack / deepset — 2 operation(s) for feedback_tags.

Haystack / deepset File API

The File API from Haystack / deepset — 8 operation(s) for file.

Haystack / deepset Haystack API

The haystack API from Haystack / deepset — 8 operation(s) for haystack.

Haystack / deepset Health API

The Health API from Haystack / deepset — 1 operation(s) for health.

Haystack / deepset Indexes API

The indexes API from Haystack / deepset — 12 operation(s) for indexes.

Haystack / deepset Infrastructure API

The Infrastructure API from Haystack / deepset — 4 operation(s) for infrastructure.

Haystack / deepset Jobs API

The Jobs API from Haystack / deepset — 15 operation(s) for jobs.

Haystack / deepset MCP API

The MCP API from Haystack / deepset — 5 operation(s) for mcp.

Haystack / deepset Model API

The Model API from Haystack / deepset — 8 operation(s) for model.

Haystack / deepset Organization API

The Organization API from Haystack / deepset — 3 operation(s) for organization.

Haystack / deepset Organization Permissions API

The organization_permissions API from Haystack / deepset — 1 operation(s) for organization_permissions.

Haystack / deepset Organization Roles API

The organization_roles API from Haystack / deepset — 2 operation(s) for organization_roles.

Haystack / deepset Pipeline API

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

Haystack / deepset Pipeline Templates API

The pipeline_templates API from Haystack / deepset — 2 operation(s) for pipeline_templates.

Haystack / deepset Pipeline Utils API

The pipeline_utils API from Haystack / deepset — 1 operation(s) for pipeline_utils.

Haystack / deepset Prompts API

The Prompts API from Haystack / deepset — 3 operation(s) for prompts.

Haystack / deepset Search Session API

The search_session API from Haystack / deepset — 2 operation(s) for search_session.

Haystack / deepset Secrets API

The Secrets API from Haystack / deepset — 8 operation(s) for secrets.

Haystack / deepset Shared Prototype API

The shared_prototype API from Haystack / deepset — 2 operation(s) for shared_prototype.

Haystack / deepset Skills API

The Skills API from Haystack / deepset — 5 operation(s) for skills.

Haystack / deepset SSO Connections API

The sso_connections API from Haystack / deepset — 4 operation(s) for sso_connections.

Haystack / deepset Token Usage API

The token_usage API from Haystack / deepset — 3 operation(s) for token_usage.

Haystack / deepset Tools API

The Tools API from Haystack / deepset — 4 operation(s) for tools.

Haystack / deepset Upload Session API

The upload_session API from Haystack / deepset — 2 operation(s) for upload_session.

Haystack / deepset User API

The User API from Haystack / deepset — 7 operation(s) for user.

Haystack / deepset Workspace API

The Workspace API from Haystack / deepset — 6 operation(s) for workspace.

Scroll for all 42

Open Collections 5

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

deepset Cloud API (deepset AI Platform) Files API

OPEN COLLECTION

deepset Cloud API (deepset AI Platform) Files Pipelines API

OPEN COLLECTION

deepset Cloud API (deepset AI Platform) Files Search API

OPEN COLLECTION

deepset Cloud API (deepset AI Platform) Files Workspaces API

OPEN COLLECTION

deepset Cloud API (deepset AI Platform)

OPEN COLLECTION

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

Haystack / deepset MCP Server

Remote MCP server at docs.haystack.deepset.ai over HTTP.

MCP SERVER

Haystack / deepset API pricing

Not yet checked against Haystack / deepset's own pricing page. Compiled by API Evangelist on 2026-06-20 from www.deepset.ai/pricing; confirm before you rely on a figure. A free plan or tier is listed.

Plan	Price
Haystack Open Source free	—
deepset AI Platform (deepset Cloud) enterprise	—

Plan details, limits and sources →

Rate limits

Search Request Timeout: ~120 seconds duration
Other Request Timeout: ~180 seconds duration
Pagination Limit: see provider documentation items

Compiled by API Evangelist, not yet checked against Haystack / deepset's documentation. All 5 limits →

Pricing Plans 1

Published pricing tiers and plan structures.

Haystack / deepset Plans Pricing

2 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Haystack / deepset Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Haystack / deepset Finops

FINOPS

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs. Counts are the severity each rule declares, not results of running them.

Haystack / deepset API Rules

64 rules · 37 error-severity 19 warn-severity 8 info-severity

SPECTRAL

OpenAPI Overlays 2

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Haystack / deepset Health Api Certification Overlay

1 action · update · haystack-ai-health-api-openapi.yml

DERIVED

Haystack / deepset Organization Permissions Api Certification Overlay

1 action · update · haystack-ai-organization-permissions-api-openapi.yml

DERIVED

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Haystack / deepset Authentication

http · 1 scheme

SECURITY

Haystack / deepset Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access (API Evangelist recommendations) 1

Recommended x-agentic-access execution contracts for AI agents.

Haystack / deepset Agentic Access

319 operations · 174 acting · 2 human-in-the-loop

319 operations · 174 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 2

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

LlmsText

LlmsText

Build 1

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 1

Status, limits, changes, and where to get help

RateLimits

RateLimits

Commercial 2

Pricing, plans, and the legal terms of use

Plans

Plans

FinOps

FinOps

Company 3

The organization behind the API

LinkedIn

Website

Website

Blog

Blog

Other 1

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Source (apis.yml)

aid: haystack-ai
url: https://raw.githubusercontent.com/api-evangelist/haystack-ai/refs/heads/main/apis.yml
name: Haystack / deepset
kind: company
description: 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.
deliveryModel:
  model: saas
  license_evidence:
    not_product:
    - deepset-ai/hayhooks
    - deepset-ai/haystack
  open_source: unknown
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: low
  source:
  - openapi
  - pricing
  - repository-not-product
  generated: '2026-09-25'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Freemium · Self-serve signup
  confidence: medium
  source:
  - plans
  - authentication
  - security
  generated: '2026-11-13'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/haystack-ai.png
x-docs-platform: docusaurus
x-docs-platform-confidence: medium
x-docs-platform-checked: 2026-10-03
tags:
- Artificial Intelligence
- LLM
- RAG
- Open Source
- Orchestration
tags_raw:
- AI
- LLM
- RAG
- Open Source
- Orchestration
- Open-Source
created: '2026-06-20'
modified: '2026-08-08'
specificationVersion: '0.23'
apis:
- aid: haystack-ai:haystack-framework
  name: Haystack Framework (Open Source)
  tags:
  - Framework
  - Python
  - Pipelines
  - Open Source
  tags_raw:
  - Framework
  - Python
  - Pipelines
  - Open Source
  - Open-Source
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://github.com/deepset-ai/haystack
  properties:
  - url: https://docs.haystack.deepset.ai/docs/intro
    type: Documentation
  - url: https://docs.haystack.deepset.ai/reference
    type: APIReference
  - url: https://github.com/deepset-ai/haystack
    type: GitHub
  description: Apache-2.0 licensed Python framework for composable LLM orchestration. Build modular Pipelines from Components
    (retrievers, routers, embedders, generators, evaluators) over Document Stores for RAG, semantic search, and agents. Programmatic
    library/SDK surface, not a hosted REST API.
- aid: haystack-ai:hayhooks-rest-deployment
  name: Hayhooks REST Deployment
  tags:
  - REST
  - Deployment
  - Pipelines
  - MCP
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://github.com/deepset-ai/hayhooks
  baseURL: https://github.com/deepset-ai/hayhooks
  properties:
  - url: https://docs.haystack.deepset.ai/docs/hayhooks
    type: Documentation
  - url: https://github.com/deepset-ai/hayhooks
    type: GitHub
  description: 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 deployed surface is generated per pipeline and self-hosted,
    not a fixed public API.
- aid: haystack-ai:haystack-ai-files-api
  name: Haystack / deepset Files API
  description: Upload, list, delete, and annotate files; manage upload sessions.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://github.com/deepset-ai/haystack
  tags:
  - File
  tags_raw:
  - Files
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-files-api-openapi.yml
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/create-a-pipeline-with-rest-api
  - type: APIReference
    url: https://docs.cloud.deepset.ai/reference/api-overview
  - type: PostmanCollection
    url: collections/haystack-ai.postman_collection.json
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/run-a-search
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/upload-files
- aid: haystack-ai:haystack-ai-pipelines-api
  name: Haystack / deepset Pipelines API
  description: Create, list, deploy, and undeploy Haystack pipelines.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://github.com/deepset-ai/haystack
  tags:
  - Pipelines
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-pipelines-api-openapi.yml
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/create-a-pipeline-with-rest-api
  - type: APIReference
    url: https://docs.cloud.deepset.ai/reference/api-overview
  - type: PostmanCollection
    url: collections/haystack-ai.postman_collection.json
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/run-a-search
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/upload-files
- aid: haystack-ai:haystack-ai-search-api
  name: Haystack / deepset Search API
  description: Run queries against deployed pipelines.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://github.com/deepset-ai/haystack
  tags:
  - Search
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-search-api-openapi.yml
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/create-a-pipeline-with-rest-api
  - type: APIReference
    url: https://docs.cloud.deepset.ai/reference/api-overview
  - type: PostmanCollection
    url: collections/haystack-ai.postman_collection.json
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/run-a-search
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/upload-files
- aid: haystack-ai:haystack-ai-workspaces-api
  name: Haystack / deepset Workspaces API
  description: Manage workspaces that isolate pipelines and data.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://github.com/deepset-ai/haystack
  tags:
  - Workspace
  tags_raw:
  - Workspaces
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-workspaces-api-openapi.yml
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/create-a-pipeline-with-rest-api
  - type: APIReference
    url: https://docs.cloud.deepset.ai/reference/api-overview
  - type: PostmanCollection
    url: collections/haystack-ai.postman_collection.json
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/run-a-search
  - type: Documentation
    url: https://docs.cloud.deepset.ai/docs/upload-files
- aid: haystack-ai:haystack-ai-config-api
  name: Haystack / deepset Config API
  description: The config API from Haystack / deepset — 4 operation(s) for config.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://github.com/deepset-ai/haystack
  tags:
  - Config
  tags_raw:
  - config
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-config-api-openapi.yml
  - type: Documentation
    url: https://deepset-ai.github.io/hayhooks/
  - type: APIReference
    url: https://deepset-ai.github.io/hayhooks/reference/api-reference/
  - type: GettingStarted
    url: https://deepset-ai.github.io/hayhooks/getting-started/quick-start/
  - type: SourceCode
    url: https://github.com/deepset-ai/hayhooks
- aid: haystack-ai:haystack-ai-dashboard-api
  name: Haystack / deepset Dashboard API
  description: The dashboard API from Haystack / deepset — 5 operation(s) for dashboard.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://github.com/deepset-ai/haystack
  tags:
  - Dashboards
  tags_raw:
  - dashboard
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-dashboard-api-openapi.yml
  - type: Documentation
    url: https://deepset-ai.github.io/hayhooks/
  - type: APIReference
    url: https://deepset-ai.github.io/hayhooks/reference/api-reference/
  - type: GettingStarted
    url: https://deepset-ai.github.io/hayhooks/getting-started/quick-start/
  - type: SourceCode
    url: https://github.com/deepset-ai/hayhooks
- aid: haystack-ai:haystack-ai-openai-api
  name: Haystack / deepset Openai API
  description: The openai API from Haystack / deepset — 8 operation(s) for openai.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://github.com/deepset-ai/haystack
  tags:
  - OpenAI
  tags_raw:
  - openai
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-openai-api-openapi.yml
  - type: Documentation
    url: https://deepset-ai.github.io/hayhooks/
  - type: APIReference
    url: https://deepset-ai.github.io/hayhooks/reference/api-reference/
  - type: GettingStarted
    url: https://deepset-ai.github.io/hayhooks/getting-started/quick-start/
  - type: SourceCode
    url: https://github.com/deepset-ai/hayhooks
- aid: haystack-ai:haystack-ai-status-api
  name: Haystack / deepset Status API
  description: The status API from Haystack / deepset — 2 operation(s) for status.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://github.com/deepset-ai/haystack
  tags:
  - Status
  tags_raw:
  - status
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-status-api-openapi.yml
  - type: Documentation
    url: https://deepset-ai.github.io/hayhooks/
  - type: APIReference
    url: https://deepset-ai.github.io/hayhooks/reference/api-reference/
  - type: GettingStarted
    url: https://deepset-ai.github.io/hayhooks/getting-started/quick-start/
  - type: SourceCode
    url: https://github.com/deepset-ai/hayhooks
- aid: haystack-ai:haystack-ai-api-token-api
  name: Haystack / deepset API Token API
  description: The api_token API from Haystack / deepset — 4 operation(s) for api_token.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - API Token
  tags_raw:
  - api_token
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-api-token-api-openapi.yml
- aid: haystack-ai:haystack-ai-custom-components-api
  name: Haystack / deepset Custom Components API
  description: The custom_components API from Haystack / deepset — 3 operation(s) for custom_components.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Custom Components
  tags_raw:
  - custom_components
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-custom-components-api-openapi.yml
- aid: haystack-ai:haystack-ai-datasets-api
  name: Haystack / deepset Datasets API
  description: The Datasets API from Haystack / deepset — 2 operation(s) for datasets.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Datasets
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-datasets-api-openapi.yml
- aid: haystack-ai:haystack-ai-debug-tunnel-api
  name: Haystack / deepset Debug Tunnel API
  description: The debug_tunnel API from Haystack / deepset — 1 operation(s) for debug_tunnel.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags: []
  tags_raw:
  - debug_tunnel
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-debug-tunnel-api-openapi.yml
- aid: haystack-ai:haystack-ai-deployments-api
  name: Haystack / deepset Deployments API
  description: The Deployments API from Haystack / deepset — 19 operation(s) for deployments.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Deployment
  tags_raw:
  - Deployments
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-deployments-api-openapi.yml
- aid: haystack-ai:haystack-ai-feedback-api
  name: Haystack / deepset Feedback API
  description: The Feedback API from Haystack / deepset — 4 operation(s) for feedback.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Feedback
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-feedback-api-openapi.yml
- aid: haystack-ai:haystack-ai-feedback-tags-api
  name: Haystack / deepset Feedback Tags API
  description: The feedback_tags API from Haystack / deepset — 2 operation(s) for feedback_tags.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags: []
  tags_raw:
  - feedback_tags
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-feedback-tags-api-openapi.yml
- aid: haystack-ai:haystack-ai-file-api
  name: Haystack / deepset File API
  description: The File API from Haystack / deepset — 8 operation(s) for file.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - File
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-file-api-openapi.yml
- aid: haystack-ai:haystack-ai-haystack-api
  name: Haystack / deepset Haystack API
  description: The haystack API from Haystack / deepset — 8 operation(s) for haystack.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - haystack
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-haystack-api-openapi.yml
- aid: haystack-ai:haystack-ai-health-api
  name: Haystack / deepset Health API
  description: The Health API from Haystack / deepset — 1 operation(s) for health.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Health
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-health-api-openapi.yml
- aid: haystack-ai:haystack-ai-indexes-api
  name: Haystack / deepset Indexes API
  description: The indexes API from Haystack / deepset — 12 operation(s) for indexes.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Index
  tags_raw:
  - indexes
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-indexes-api-openapi.yml
- aid: haystack-ai:haystack-ai-infrastructure-api
  name: Haystack / deepset Infrastructure API
  description: The Infrastructure API from Haystack / deepset — 4 operation(s) for infrastructure.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Infrastructure
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-infrastructure-api-openapi.yml
- aid: haystack-ai:haystack-ai-jobs-api
  name: Haystack / deepset Jobs API
  description: The Jobs API from Haystack / deepset — 15 operation(s) for jobs.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Job
  tags_raw:
  - Jobs
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-jobs-api-openapi.yml
- aid: haystack-ai:haystack-ai-mcp-api
  name: Haystack / deepset MCP API
  description: The MCP API from Haystack / deepset — 5 operation(s) for mcp.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - MCP
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-mcp-api-openapi.yml
- aid: haystack-ai:haystack-ai-model-api
  name: Haystack / deepset Model API
  description: The Model API from Haystack / deepset — 8 operation(s) for model.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Model
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-model-api-openapi.yml
- aid: haystack-ai:haystack-ai-organization-api
  name: Haystack / deepset Organization API
  description: The Organization API from Haystack / deepset — 3 operation(s) for organization.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Organization
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-organization-api-openapi.yml
- aid: haystack-ai:haystack-ai-organization-permissions-api
  name: Haystack / deepset Organization Permissions API
  description: The organization_permissions API from Haystack / deepset — 1 operation(s) for organization_permissions.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Organization Permissions
  tags_raw:
  - organization_permissions
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-organization-permissions-api-openapi.yml
- aid: haystack-ai:haystack-ai-organization-roles-api
  name: Haystack / deepset Organization Roles API
  description: The organization_roles API from Haystack / deepset — 2 operation(s) for organization_roles.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Organization Roles
  tags_raw:
  - organization_roles
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-organization-roles-api-openapi.yml
- aid: haystack-ai:haystack-ai-pipeline-api
  name: Haystack / deepset Pipeline API
  description: The Pipeline API from Haystack / deepset — 39 operation(s) for pipeline.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Pipelines
  tags_raw:
  - Pipeline
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-pipeline-api-openapi.yml
- aid: haystack-ai:haystack-ai-pipeline-templates-api
  name: Haystack / deepset Pipeline Templates API
  description: The pipeline_templates API from Haystack / deepset — 2 operation(s) for pipeline_templates.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Pipeline Templates
  tags_raw:
  - pipeline_templates
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-pipeline-templates-api-openapi.yml
- aid: haystack-ai:haystack-ai-pipeline-utils-api
  name: Haystack / deepset Pipeline Utils API
  description: The pipeline_utils API from Haystack / deepset — 1 operation(s) for pipeline_utils.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags: []
  tags_raw:
  - pipeline_utils
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-pipeline-utils-api-openapi.yml
- aid: haystack-ai:haystack-ai-prompts-api
  name: Haystack / deepset Prompts API
  description: The Prompts API from Haystack / deepset — 3 operation(s) for prompts.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Prompts
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-prompts-api-openapi.yml
- aid: haystack-ai:haystack-ai-search-session-api
  name: Haystack / deepset Search Session API
  description: The search_session API from Haystack / deepset — 2 operation(s) for search_session.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags: []
  tags_raw:
  - search_session
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-search-session-api-openapi.yml
- aid: haystack-ai:haystack-ai-secrets-api
  name: Haystack / deepset Secrets API
  description: The Secrets API from Haystack / deepset — 8 operation(s) for secrets.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Secrets
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-secrets-api-openapi.yml
- aid: haystack-ai:haystack-ai-shared-prototype-api
  name: Haystack / deepset Shared Prototype API
  description: The shared_prototype API from Haystack / deepset — 2 operation(s) for shared_prototype.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags: []
  tags_raw:
  - shared_prototype
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-shared-prototype-api-openapi.yml
- aid: haystack-ai:haystack-ai-skills-api
  name: Haystack / deepset Skills API
  description: The Skills API from Haystack / deepset — 5 operation(s) for skills.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Skills
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-skills-api-openapi.yml
- aid: haystack-ai:haystack-ai-sso-connections-api
  name: Haystack / deepset SSO Connections API
  description: The sso_connections API from Haystack / deepset — 4 operation(s) for sso_connections.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - sso-connections
  tags_raw:
  - sso_connections
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-sso-connections-api-openapi.yml
- aid: haystack-ai:haystack-ai-token-usage-api
  name: Haystack / deepset Token Usage API
  description: The token_usage API from Haystack / deepset — 3 operation(s) for token_usage.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Token Usage
  tags_raw:
  - token_usage
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-token-usage-api-openapi.yml
- aid: haystack-ai:haystack-ai-tools-api
  name: Haystack / deepset Tools API
  description: The Tools API from Haystack / deepset — 4 operation(s) for tools.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Tools
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-tools-api-openapi.yml
- aid: haystack-ai:haystack-ai-upload-session-api
  name: Haystack / deepset Upload Session API
  description: The upload_session API from Haystack / deepset — 2 operation(s) for upload_session.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags: []
  tags_raw:
  - upload_session
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-upload-session-api-openapi.yml
- aid: haystack-ai:haystack-ai-user-api
  name: Haystack / deepset User API
  description: The User API from Haystack / deepset — 7 operation(s) for user.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - User
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-user-api-openapi.yml
- aid: haystack-ai:haystack-ai-workspace-api
  name: Haystack / deepset Workspace API
  description: The Workspace API from Haystack / deepset — 6 operation(s) for workspace.
  humanURL: https://docs.haystack.deepset.ai/docs/intro
  baseURL: https://api.cloud.deepset.ai
  tags:
  - Workspace
  properties:
  - type: OpenAPI
    url: openapi/haystack-ai-workspace-api-openapi.yml
common:
- type: CapabilityMap
  url: capabilities/haystack-ai-capability-edges.yml
  name: Haystack / deepset Business Capability Map
- type: AgenticAccess
  url: agentic-access/haystack-ai-agentic-access.yml
- type: DomainSecurity
  url: security/haystack-ai-domain-security.yml
- type: Authentication
  url: authentication/haystack-ai-authentication.yml
- type: GitHubOrganization
  url: https://github.com/deepset-ai
- type: LinkedIn
  url: https://www.linkedin.com/company/deepset
- type: Website
  url: https://haystack.deepset.ai
- type: Documentation
  url: https://docs.haystack.deepset.ai/docs/intro
- type: Plans
  url: plans/haystack-ai-plans-pricing.yml
- type: RateLimits
  url: rate-limits/haystack-ai-rate-limits.yml
- type: FinOps
  url: finops/haystack-ai-finops.yml
- url: https://haystack.deepset.ai/blog
  type: Blog
- type: LlmsText
  url: https://docs.haystack.deepset.ai/llms.txt
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
x-merged-from:
- haystack

Haystack / deepset API — frequently asked questions

Does Haystack / deepset have an API?

Yes. APIs.io lists 42 APIs from Haystack / deepset, including Haystack Framework (Open Source), Hayhooks REST Deployment and Haystack / deepset Files API, and 39 more.

Is there an OpenAPI specification for the Haystack / deepset API?

Yes. APIs.io indexes 40 OpenAPI specifications for Haystack / deepset, each linked for download from this page.

How do I authenticate with the Haystack / deepset API?

Haystack / deepset uses bearer-token authentication (http · 1 scheme). The details are profiled on APIs.io as Haystack / deepset Authentication.

How much does the Haystack / deepset API cost?

APIs.io lists 2 pricing plans for Haystack / deepset, with each plan's price, limits and inclusions under Pricing on this page.

Does Haystack / deepset have an MCP server?

Yes. APIs.io lists 1 MCP server for Haystack / deepset: Remote MCP server at docs.haystack.deepset.ai over HTTP.

Is the Haystack / deepset API ready for AI agents?

Haystack / deepset has a Kin Score of 32.5 out of 100 (thin) and an Agent Readiness score of 47.0 (agent-native), scored by API Evangelist on 2026-11-13.

Work with this as data

Every provider 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 providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
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 provider

curl "https://apis.io/api/v1/providers/haystack-ai"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/haystack-ai/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/haystack-ai/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.