Skip to main content
Currently in beta. You’re on the priority waitlist and among the first to get access.

​
Overview

Stream audio in real-time with the lowest latency. Perfect for interactive assistants and live applications. For simpler use cases, see TTS REST or TTS SSE.
Passing numbers, IDs, dates, or currency as raw strings causes mispronunciations. See the Input Formatting Guide for correct formatting of phone numbers, account numbers, PINs, Aadhaar, vehicle registration numbers, GSTIN, currency, and more.

​
Endpoint

wss://api.vachana.ai/api/v1/tts

​
Authentication

All Realtime connections require the following headers:
HeaderRequiredDescriptionExample
Content-TypeYesMust be application/jsonapplication/json
X-API-Key-IDYesYour API key for authentication<your-api-key-id>

​
Request Format

Send a JSON message with the following structure: 
{
  "text": "नमस्ते, आप कैसे हैं?",
  "model": "vachana-voice-v2",
  "audio_config": {
    "sample_rate": 44100,
    "encoding": "linear_pcm"
  },
  "speaker_embedding": {
    "embedding": "string",
    "shape": [1, 768],
    "dtype": "torch.bfloat16"
  }
}
​
num_channels
integer
required
Number of audio channels (e.g., 1 for mono, 2 for stereo)
​
sample_width
integer
required
Sample width in bytes (e.g., 2 for 16-bit audio)
​
encoding
string
required
Audio encoding format (e.g., linear_pcm)
​
container
string
required
Audio container format (e.g., wav)

​
Response

The server streams audio data in real-time as binary chunks. Each chunk contains PCM audio data according to the specified audio_config.

​
Example Usage

const ws = new WebSocket("wss://api.vachana.ai/api/v1/tts", {
  headers: {
    "Content-Type": "application/json",
    "X-API-Key-ID": "<your-api-key>",
  },
});

ws.on("open", () => {
  const request = {
    text: "नमस्ते, आप कैसे हैं?",
    model: "vachana-voice-v2",
    audio_config: {
      sample_rate: 44100,
      encoding: "linear_pcm",
    },
    speaker_embedding: {
      embedding: "string",
      shape: [1, 768],
      dtype: "torch.bfloat16",
    },
  };

  ws.send(JSON.stringify(request));
});

ws.on("message", (data) => {
  // Handle audio chunks
  console.log("Received audio chunk:", data);
});

ws.on("error", (error) => {
  console.error("WebSocket error:", error);
});

ws.on("close", () => {
  console.log("WebSocket connection closed");
});