Speech-to-speech (EVI)Configs

Update config description

Updates the description of a Config.

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

Path parameters

idstringRequiredformat: "uuid"
Identifier for a Config. Formatted as a UUID.
versionintegerRequired
Version number for a Config. Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed. Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.

Request

This endpoint expects an object.
version_descriptionstring or nullOptional
An optional description of the Config version.

Response

Success
builtin_toolslist of objects or null

List of built-in tools associated with this Config.

created_onlong
Time at which the Config was created. Measured in seconds since the Unix epoch.
ellm_modelobject
A specific eLLM Model configuration
event_messagesobject
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

Specifies the EVI version to use. See our EVI Version Guide for differences between versions.

We’re officially sunsetting EVI versions 1 and 2 on August 30, 2025. To keep things running smoothly, be sure to migrate to EVI 3 before then.

idstring
Identifier for a Config. Formatted as a UUID.
interruptionobject
An interruption configuration returned from the server
language_modelobject
A specific LanguageModel
modified_onlong
Time at which the Config was last modified. Measured in seconds since the Unix epoch.
namestring
Name applied to all versions of a particular Config.
nudgesobject
A specific nudge configuration returned from the server
promptobject
A specific prompt version returned from the server
timeoutsobject

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.

turn_detectionobject
A turn detection configuration returned from the server
versioninteger
Version number for a Config. Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed. Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
version_descriptionstring or null
An optional description of the Config version.
voiceobject

An Octave voice available for text-to-speech

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