Punctuation Formatting

Punctuation formatting controls whether transcript text is returned with punctuation and capitalization applied, or as raw lowercase text. This is enabled by default.

Enabling Punctuation Formatting

Add the format parameter to your WebSocket connection query parameters. Options: true (default), false.

Real-Time WebSocket API

1
const url = new URL("wss://api.smallest.ai/waves/v1/pulse/get_text");
2
url.searchParams.append("language", "en");
3
url.searchParams.append("encoding", "linear16");
4
url.searchParams.append("sample_rate", "16000");
5
url.searchParams.append("format", "false"); // disable formatting
6
7
const ws = new WebSocket(url.toString(), {
8
  headers: {
9
    Authorization: `Bearer ${API_KEY}`,
10
  },
11
});

Example Output

With format=true (default)

1
{
2
  "transcript": "Hello there, how can I help you today?",
3
  "is_final": true
4
}

With format=false

1
{
2
  "transcript": "hello there how can i help you today",
3
  "is_final": true
4
}

When to Use