Skip to main content

WebSocket

WebSocket carries two main capabilities:

  • text chat: /ws/v1/chat
  • realtime voice: /ws/v1/realtime

When to use it​

  • when you need a persistent bidirectional connection
  • when you need low-latency text interaction
  • when you need realtime voice input and output

Voice requirements​

Before enabling realtime voice, make sure:

  • the service enables websocket
  • the voice preset is configured
  • MushroomAgent-core[voice] is installed