Speech-to-speech (EVI)Configs

Create config

Creates a Config which can be applied to EVI.

For more details on configuration options and how to configure EVI, see our configuration guide.

Authentication

X-Hume-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
evi_versionstringRequired

EVI version to use. Only versions 3 and 4-mini are supported.

namestringRequired
Name applied to all versions of a particular Config.
builtin_toolslist of objects or nullOptional

List of built-in tools associated with this Config.

ellm_modelobjectOptional

The eLLM setup associated with this Config.

Hume’s eLLM (empathic Large Language Model) is a multimodal language model that takes into account both expression measures and language. The eLLM generates short, empathic language responses and guides text-to-speech (TTS) prosody.

event_messagesobjectOptional
Collection of event messages returned by the server. Event messages are sent by the server when specific events occur during a chat session. These messages are used to configure behaviors for EVI, such as controlling how EVI starts a new conversation.
language_modelobjectOptional

The supplemental language model associated with this Config.

This model is used to generate longer, more detailed responses from EVI. Choosing an appropriate supplemental language model for your use case is crucial for generating fast, high-quality responses from EVI.

nudgesobjectOptional
Configures nudges, brief audio prompts that can guide conversations when users pause or need encouragement to continue speaking. Nudges help create more natural, flowing interactions by providing gentle conversational cues.
promptobjectOptional
Identifies which prompt to use in a a config OR how to create a new prompt to use in the config
timeoutsobjectOptional

Collection of timeout specifications returned by the server.

Timeouts are sent by the server when specific time-based events occur during a chat session. These specifications set the inactivity timeout and the maximum duration an EVI WebSocket connection can stay open before it is automatically disconnected.

toolslist of objects or nullOptional

List of user-defined tools associated with this Config.

version_descriptionstring or nullOptional
An optional description of the Config version.
voiceobjectOptional
A voice specification associated with this Config.
webhookslist of objects or nullOptional
Webhook config specifications for each subscriber.

Response

Created
builtin_toolslist of objects or null

List of built-in tools associated with this config

created_onlong or null
The timestamp when the first version of this config was created.
ellm_modelobject or null
A specific eLLM Model configuration
event_messagesobject or null
Collection of event messages returned by the server. Event messages are sent by the server when specific events occur during a chat session. These messages are used to configure behaviors for EVI, such as controlling how EVI starts a new conversation.
evi_versionstring or null
The version of the EVI used with this config.
idstring or null
Identifier for a Config. Formatted as a UUID.
language_modelobject or null
A specific LanguageModel
modified_onlong or null
The timestamp when this version of the config was created.
namestring or null
Name applied to all versions of a particular Config.
nudgesobject or null
A specific nudge configuration returned from the server
promptobject or null
A specific prompt version returned from the server
timeoutsobject or null

Collection of timeout specifications returned by the server.

Timeouts are sent by the server when specific time-based events occur during a chat session. These specifications set the inactivity timeout and the maximum duration an EVI WebSocket connection can stay open before it is automatically disconnected.

toolslist of objects or null

List of user-defined tools associated with this config.

versioninteger or null
Version number for a Config. Version numbers should be integers. The combination of configId and version number is unique.
version_descriptionstring or null
Description that is appended to a specific version of a Config.
voiceobject or null

An Octave voice available for text-to-speech

webhookslist of objects or null
Map of webhooks associated with this config.