POST
/
api
/
v1
/
lightning-large
/
stream
curl --request POST \
  --url https://waves-api.smallest.ai/api/v1/lightning-large/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "<string>",
  "voice_id": "<string>",
  "add_wav_header": false,
  "sample_rate": 24000,
  "speed": 1,
  "language": "en",
  "consistency": 0.5,
  "similarity": 0,
  "enhancement": 1
}'
{
  "data": "event: chunk\ndata: <WAV_DATA>\ndone: false\n"
}

​
Overview

The Lightning-Large SSE API provides real-time text-to-speech streaming capabilities with high-quality voice synthesis. This API uses Server-Sent Events (SSE) to deliver audio chunks as they’re generated, enabling low-latency audio playback without waiting for the entire audio file to process.

​
When to Use

  • Interactive Applications: Perfect for chatbots, virtual assistants, and other applications requiring immediate voice responses
  • Long-Form Content: Efficiently stream audio for articles, stories, or other long-form content without buffering delays
  • Voice User Interfaces: Create natural-sounding voice interfaces with minimal perceived latency
  • Accessibility Solutions: Provide real-time audio versions of written content for users with visual impairments

​
How It Works

  1. Make a POST Request: Send your text and voice settings to the API endpoint
  2. Receive Audio Chunks: The API processes your text and streams audio back as base64-encoded chunks with 1024 byte size
  3. Process the Stream: Handle the SSE events to decode and play audio chunks sequentially
  4. End of Stream: The API sends a completion event when all audio has been delivered

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
text
string
required

The text to convert to speech.

​
voice_id
string
required

The voice identifier to use for speech generation.

​
add_wav_header
boolean
default:false

Whether to add WAV header to the output.

​
sample_rate
integer
default:24000

The sample rate for the generated audio.

Required range: 8000 <= x <= 24000
​
speed
number
default:1

The speed of the generated speech.

Required range: 0.5 <= x <= 2
​
language
enum<string>
default:en

Determines how numbers are spelled out. If set to 'en', numbers will be read as individual digits in English. If set to 'hi', numbers will be read as individual digits in Hindi.

Available options:
en,
hi,
ta,
fr,
de,
pl
​
consistency
number
default:0.5

This parameter controls word repetition and skipping. Decrease it to prevent skipped words, and increase it to prevent repetition.

Required range: 0 <= x <= 1
​
similarity
number
default:0

This parameter controls the similarity between the generated speech and the reference audio. Increase it to make the speech more similar to the reference audio.

Required range: 0 <= x <= 1
​
enhancement
number
default:1

Enhances speech quality at the cost of increased latency.

Required range: 0 <= x <= 2

Response

200
text/event-stream
Synthesized speech retrieved successfully.

The response is of type file.