Streaming Protocols (Advanced)

📋 Planned

Documentation Under Construction

This advanced page will explain the technical details of Vanna's streaming protocols, including Server-Sent Events (SSE), WebSockets, and polling fallback.

Planned Content

  • ✓ Overview of streaming in Vanna
  • ✓ Server-Sent Events (SSE) - recommended
  • ✓ WebSocket protocol - alternative
  • ✓ Polling - fallback for restricted environments
  • ✓ Component update protocol
  • ✓ Message format and schemas
  • ✓ Implementing custom streaming endpoints
  • ✓ Performance considerations

Want to contribute or suggest improvements? Open an issue on GitHub

Streaming Options

When complete, this will explain:

Server-Sent Events (SSE) - Recommended

  • Simpler than WebSockets
  • Works through most proxies/firewalls
  • Automatic reconnection
  • Good for one-way server → client streaming
Endpoint: POST /api/vanna/v2/chat_sse
Content-Type: text/event-stream

WebSocket - Alternative

  • Full bidirectional communication
  • Lower latency
  • More complex infrastructure
  • May require special proxy configuration
Endpoint: WS /api/vanna/v2/chat_websocket

Polling - Fallback

  • Maximum compatibility
  • Higher latency
  • More server load
  • Use only when SSE/WS unavailable
Endpoint: POST /api/vanna/v2/chat_poll

Component Updates

How components update during streaming:

  1. Agent starts execution → Send component with “loading” state
  2. Tool executes → Update component with progress
  3. Tool completes → Update component with final state
  4. Agent responds → Add text messages

Message Protocol

The page will document:

  • Message types (text, component, tool_invocation)
  • Component update payloads
  • Error handling
  • Completion signals