Skip to navigation

Punctuation Formatting

Control punctuation and capitalization formatting in real-time transcripts.
View as Markdown
Real-Time

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.

const url = new URL("wss://api.smallest.ai/waves/v1/stt/live?model=pulse");
url.searchParams.append("language", "en");
url.searchParams.append("encoding", "linear16");
url.searchParams.append("sample_rate", "16000");
url.searchParams.append("format", "false"); // disable formatting
const ws = new WebSocket(url.toString(), {
headers: {
Authorization: `Bearer ${API_KEY}`,
},
});

Example Output

With format=true (default)

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

With format=false

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

When to Use

Use caseRecommended setting
Live captions and subtitlesformat=true - human-readable output
Meeting transcriptionformat=true - properly formatted text
Feeding into LLMs or NLP pipelinesformat=false - raw text avoids double-formatting
Search indexingformat=false - normalized text for consistent matching
Custom post-processingformat=false - apply your own punctuation and casing rules