Speech-to-speech (EVI)Configs

Create config version

Updates a Config by creating a new version of the Config.

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

Path parameters

idstringRequiredformat: "uuid"
Identifier for a Config. Formatted as a UUID.

Headers

X-Hume-Api-KeystringRequired

Request

This endpoint expects an object.
evi_versionstringRequired
The version of the EVI used with this config.
version_descriptionstringOptional
An optional description of the Config version.
promptobjectOptional
Identifies which prompt to use in a a config OR how to create a new prompt to use in the config
voiceobjectOptional
A voice specification associated with this Config version.
language_modelobjectOptional

The supplemental language model associated with this Config version.

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.

ellm_modelobjectOptional

The eLLM setup associated with this Config version.

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.

toolslist of objectsOptional

List of user-defined tools associated with this Config version.

builtin_toolslist of objectsOptional

List of built-in tools associated with this Config version.

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.
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.

nudgesobjectOptional
A nudge specification posted to the server
webhookslist of objectsOptional
Webhook config specifications for each subscriber.

Response

Created
idstring or null
Identifier for a Config. Formatted as a UUID.
versioninteger or null
Version number for a Config. Version numbers should be integers. The combination of configId and version number is unique.
evi_versionstring or null
The version of the EVI used with this config.
version_descriptionstring or null
Description that is appended to a specific version of a Config.
namestring or null
Name applied to all versions of a particular Config.
created_onlong or null
The timestamp when the first version of this config was created.
modified_onlong or null
The timestamp when this version of the config was created.
promptobject or null
A specific prompt version returned from the server
voiceany or null
language_modelobject or null
A specific LanguageModel
ellm_modelobject or null
A specific eLLM Model configuration
toolslist of objects or null

List of user-defined tools associated with this config.

builtin_toolslist of objects or null

List of built-in tools associated with this config

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.
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.

nudgesobject or null
A specific nudge configuration returned from the server
webhookslist of objects or null
Map of webhooks associated with this config.