Class LiveSpeechRequest
Parameters of POST /v1/audio/speech/live: chunked PCM body in, SSE or raw audio
out. All request fields travel as query parameters because the body carries audio.
public sealed class LiveSpeechRequest
- Inheritance
-
LiveSpeechRequest
- Inherited Members
Properties
BusyTimeoutMs
Upper bound on waiting for a busy model, in milliseconds.
public long? BusyTimeoutMs { get; set; }
Property Value
- long?
Channels
Interleaved channel count of the PCM body; 1–16. Server default 1.
public int? Channels { get; set; }
Property Value
- int?
Input
Text for a text-to-speech model (required for it); speech-to-speech, vc and
svc models treat it as an optional prompt.
public string? Input { get; set; }
Property Value
Language
Language code.
public string? Language { get; set; }
Property Value
Model
Configured streaming model id. Required.
public string? Model { get; set; }
Property Value
Options
Extra query-passed options the live handler recognizes: temperature,
top_k, top_p, max_tokens, max_steps,
repetition_penalty, guidance_scale, num_inference_steps,
system_prompt, instructions (maps to system_prompt),
voice_id, reference_text, text_temperature, text_top_k,
do_sample.
public Dictionary<string, string>? Options { get; set; }
Property Value
ReturnText
Stream the text the model writes as it speaks; requires StreamFormat = sse.
public bool? ReturnText { get; set; }
Property Value
- bool?
SampleFormat
s16le (default) or f32le.
public string? SampleFormat { get; set; }
Property Value
SampleRate
Sample rate of the PCM body; 1000–384000. Server default 16000.
public int? SampleRate { get; set; }
Property Value
- int?
Seed
Sampling seed as decimal text (full uint64 range).
public string? Seed { get; set; }
Property Value
StreamFormat
sse (default) or audio. The route only supports response_format=pcm.
public StreamFormat StreamFormat { get; set; }
Property Value
Voice
Voice preset / native voice id.
public string? Voice { get; set; }
Property Value
Methods
BuildQueryString()
Validates the request and builds the query string.
public string BuildQueryString()
Returns
- string
The encoded query string with a leading
?.