Async Operations Example

July 10, 2026 ยท View on GitHub

Patterns for async pipelines in Hayhooks: streaming responses, concurrency, and background work. Use these patterns when you need high throughput or to avoid blocking.

Where is the code?

  • Async wrapper: async_question_answer
  • See main docs for async run_api_async and run_chat_completion_async

Deploy (example)

hayhooks pipeline deploy-files -n async-question-answer examples/pipeline_wrappers/async_question_answer

Run

  • OpenAI-compatible chat (async streaming):
curl -X POST http://localhost:1416/v1/chat/completions \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "async-question-answer",
    "messages": [{"role": "user", "content": "Tell me a joke about programming"}]
  }'

!!! tip "Best Practices" - Prefer run_chat_completion_async for streaming and concurrency - Use async-compatible components (e.g., OpenAIChatGenerator) for best performance - For legacy pipelines with sync-only components (those without run_async), use allow_sync_streaming_callbacks=True to enable hybrid mode - See Hybrid Streaming for handling legacy components