site_name: Hayhooks
site_description: Deploy and serve Haystack Pipelines and Agents as REST APIs
site_author: deepset
site_url: https://deepset-ai.github.io/hayhooks
repo_name: deepset-ai/hayhooks
repo_url: https://github.com/deepset-ai/hayhooks
nav:
- Home: index.md
- Getting Started:
- Quick Start: getting-started/quick-start.md
- Quick Start with Docker Compose: getting-started/quick-start-docker.md
- Installation: getting-started/installation.md
- Configuration: getting-started/configuration.md
- Core Concepts:
- Pipeline Deployment: concepts/pipeline-deployment.md
- PipelineWrapper: concepts/pipeline-wrapper.md
- YAML Pipeline Deployment: concepts/yaml-pipeline-deployment.md
- Agent Deployment: concepts/agent-deployment.md
- Features:
- OpenAI Compatibility: features/openai-compatibility.md
- MCP Support: features/mcp-support.md
- Open WebUI Integration: features/openwebui-integration.md
- File Upload Support: features/file-upload-support.md
- CLI Commands: features/cli-commands.md
- Advanced Usage:
- Running Pipelines: advanced/running-pipelines.md
- Advanced Configuration: advanced/advanced-configuration.md
- Code Sharing: advanced/code-sharing.md
- Deployment:
- Deployment Guidelines: deployment/deployment_guidelines.md
- Examples:
- Examples Overview: examples/overview.md
- Chat with Website: examples/chat-with-website.md
- RAG System: examples/rag-system.md
- Async Operations: examples/async-operations.md
- Open WebUI Events: examples/openwebui-events.md
- Reference:
- API Reference: reference/api-reference.md
- Environment Variables: reference/environment-variables.md
- Logging: reference/logging.md
- About:
- License: about/license.md
theme:
logo: assets/haystack_icon.png
name: material
language: en
features:
- navigation.tabs
- navigation.sections
- navigation.instant
- navigation.expand
- navigation.top
- search.suggest
- search.highlight
- content.code.copy
- content.code.annotate
- toc.integrate
font:
text: Inter
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/weather-sunny
name: Switch to light mode
plugins:
- search
- tags
- llmstxt:
markdown_description: >
Hayhooks turns Haystack Pipelines and Agents into production-ready REST
APIs, bundling deployment, observability, lifecycle tooling, and native
Model Context Protocol (MCP) endpoints for MCP-aware clients such as
Cursor or Claude Desktop.
full_output: llms-full.txt
sections:
Overview:
- index.md: Project overview and key capabilities.
Getting Started:
- getting-started/quick-start.md: Launch Hayhooks locally with the default settings.
- getting-started/quick-start-docker.md: Run Hayhooks with Docker Compose for a managed setup.
- getting-started/installation.md: Install Hayhooks and its dependencies.
- getting-started/configuration.md: Configure Hayhooks for your environment.
Core Concepts:
- concepts/pipeline-wrapper.md: Understand the PipelineWrapper abstraction.
- concepts/pipeline-deployment.md: Learn how to deploy Haystack Pipelines with Hayhooks.
- concepts/agent-deployment.md: Learn how to deploy Haystack Agents with Hayhooks.
- concepts/yaml-pipeline-deployment.md: Define and deploy Haystack Pipelines from YAML.
Features:
- features/openai-compatibility.md: Use Hayhooks with OpenAI-compatible clients.
- features/mcp-support.md: Using Hayhooks as an MCP Server for Haystack Pipelines and Agents.
- features/openwebui-integration.md: Connect Hayhooks to Open WebUI.
- features/file-upload-support.md: Handle file uploads inside pipeline runs.
- features/cli-commands.md: Discover the Hayhooks command-line tooling.
Advanced Usage:
- advanced/running-pipelines.md: Execute Haystack Pipelines and manage runs programmatically.
- advanced/advanced-configuration.md: Fine-tune advanced configuration settings.
- advanced/code-sharing.md: Share Python code securely across deployments.
Deployment:
- deployment/deployment_guidelines.md: Follow best practices for production deployments.
Examples:
- examples/overview.md: Explore the examples shipped with Hayhooks.
- examples/chat-with-website.md: Build a Haystack website-aware chat assistant.
- examples/rag-system.md: Assemble a Haystack RAG system with Hayhooks.
- examples/async-operations.md: Run asynchronous operations with Haystack Pipelines and Agents.
- examples/openwebui-events.md: Handle Open WebUI event integrations.
Reference:
- reference/api-reference.md: REST API reference for Haystack Pipelines and Agents endpoints.
- reference/environment-variables.md: Environment variables and their defaults.
- reference/logging.md: Logging configuration and observability guidance.
About:
- about/license.md: Project licensing details.
markdown_extensions:
- admonition
- attr_list
- codehilite:
guess_lang: false
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/github
link: https://github.com/deepset-ai/hayhooks
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/deepset/hayhooks
- icon: fontawesome/brands/twitter
link: https://twitter.com/deepset_ai
extra_css:
- stylesheets/extra.css
extra_javascript: []
