For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CommunitySign Up
HomeGuidesVerbsAPI ReferenceSelf-HostingClient SDKsTutorialsChangelog
HomeGuidesVerbsAPI ReferenceSelf-HostingClient SDKsTutorialsChangelog
    • Introduction
  • REST Call Control
  • REST Platform Management
  • Webhooks
    • GETNew Call
    • POSTNew Call
    • POSTClient Authentication
    • POSTNew Client Tool Request
  • Websocket API
      • Overview
      • session:new
      • session:redirect
      • session:reconnect
      • call:status
      • verb:hook
      • verb:status
      • llm:event
      • llm:tool-call
      • tts:tokens-result
      • tts:streaming-event
      • dial:confirm
      • ack
      • command
      • llm:tool-output
      • llm:update
      • tts:tokens
      • tts:flush
      • tts:clear
      • WSScallControl
LogoLogo
CommunitySign Up
Websocket APICall Control

tts:tokens

websocket server => jambonz

An tts:tokens message is sent by the application to jambonz to stream text to a speech synthesizer. This requires that a TTS speech vendor that supports streaming is being used for the call. Currrently, as of release 0.9.3 the following vendors are support for TTS streaming:

  • Cartesia
  • Deepgram
  • Elevenlabs

The payload must contain:

  • id: a unique identifier within the current tts stream, identifying this request
  • tokens: a string of text to be synthesized in streaming fashion

The intent is that as the application receives a stream of tokens from an LLM that is being managed by the application it will send this stream on via successive calls to tts:tokens.

The application will receive a tts:tokens-result message in response to each tts:tokens message it sends.

Was this page helpful?
Edit this page
Previous

tts:flush

Next
Built with