Stream Input | Hume API

HandshakeTry it

WSS

wss://api.hume.ai/v0/tts/stream/input

Query parameters

access_token

string Optional
Defaults to ``
Access token used for authenticating the client. If not provided, an api_key must be provided to authenticate.
The access token is generated using both an API key and a Secret key, which provides an additional layer of security compared to using just an API key.
For more details, refer to the Authentication Strategies Guide.

context_generation_id

string Optional
The ID of a prior TTS generation to use as context for generating consistent speech style and prosody across multiple requests. Including context may increase audio generation times.

format_type

enum Optional
The format to be used for audio generation.

Show 1 variants

include_timestamp_types

list of enums Optional
Defaults to []
The set of timestamp types to include in the response. Only supported for Octave 2 requests.
Allowed values: word, phoneme

instant_mode

boolean Optional
Defaults to true
Enables ultra-low latency streaming, significantly reducing the time until the first audio chunk is received. Recommended for real-time applications requiring immediate audio playback. For further details, see our documentation on instant mode.

no_binary

boolean Optional
Defaults to false
If enabled, no binary websocket messages will be sent to the client.

strip_headers

boolean Optional
Defaults to false
If enabled, the audio for all the chunks of a generation, once concatenated together, will constitute a single audio file. Otherwise, if disabled, each chunk’s audio will be its own audio file, each with its own headers (if applicable).

temperature

double Optional
Sampling temperature for the speech generation model. Higher values increase variation; lower values increase consistency.

This is an experimental parameter. It is recommended to use the default values for most use cases.

Defaults when omitted:

version

enum Optional
The version of the Octave Model to use. 1 for the legacy model, 2 for the new model.

Show 1 variants

api_key

string Optional
Defaults to ``
API key used for authenticating the client. If not provided, an access_token must be provided to authenticate.
For more details, refer to the Authentication Strategies Guide.

Send

InputMessage

object Required
Input message type for the TTS stream.
Show 7 properties

Receive

TtsOutput

object Required
Output message type for the TTS stream.
Show 2 variants

Ask AI