Quick Start¶
This guide will help you get started with Hayhooks quickly.
Prerequisites¶
- Python 3.9+
- A Haystack pipeline or agent to deploy
Installation¶
See Installation for detailed setup instructions.
Quick install:
pip install hayhooks
Basic Usage¶
1. Start Hayhooks¶
hayhooks run
This will start the Hayhooks server on http://localhost:1416
by default.
2. Deploy a Pipeline¶
Deploy a pipeline using the deploy-files
command:
hayhooks pipeline deploy-files -n chat_with_website examples/pipeline_wrappers/chat_with_website_streaming
3. Check Status¶
Verify your pipeline is deployed:
hayhooks status
4. Run Your Pipeline¶
Run your pipeline via the API:
curl -X POST \
http://localhost:1416/chat_with_website/run \
-H 'Content-Type: application/json' \
-d '{"urls": ["https://haystack.deepset.ai"], "question": "What is Haystack?"}'
import requests
response = requests.post(
"http://localhost:1416/chat_with_website/run",
json={
"urls": ["https://haystack.deepset.ai"],
"question": "What is Haystack?"
}
)
print(response.json())
hayhooks pipeline run chat_with_website \
--param 'urls=["https://haystack.deepset.ai"]' \
--param 'question="What is Haystack?"'
Quick Start with Docker Compose¶
For the fastest setup with Open WebUI integration, see Quick Start with Docker Compose.
Next Steps¶
- Pipeline Deployment - Learn deployment methods
- Examples - Explore example implementations