Configs

Create config

POST

Request

This endpoint expects an object.
name
stringRequired
Name applied to all versions of a particular Config.
version_description
stringOptional
An optional description of the Config version.
prompt
objectOptional
A Prompt associated with this Config.
voice
objectOptional
A voice specification associated with this Config.
language_model
objectOptional

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.

ellm_model
objectOptional

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.

tools
list of optional objectsOptional
List of user-defined tools associated with this Config.
builtin_tools
list of optional objectsOptional
List of built-in tools associated with this Config.
event_messages
objectOptional

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.

timeouts
objectOptional

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.

Response

This endpoint returns an object
id
stringOptional
Identifier for a Config. Formatted as a UUID.
version
integerOptional

Version number for a Config.

Configs, as well as Prompts 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_description
stringOptional
An optional description of the Config version.
name
stringOptional
Name applied to all versions of a particular Config.
created_on
integerOptional
Time at which the Config was created. Measured in seconds since the Unix epoch.
modified_on
integerOptional
Time at which the Config was last modified. Measured in seconds since the Unix epoch.
prompt
objectOptional
A Prompt associated with this Config.
voice
objectOptional
A voice specification associated with this Config.
language_model
objectOptional

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.

ellm_model
objectOptional

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.

tools
list of optional objectsOptional
List of user-defined tools associated with this Config.
builtin_tools
list of optional objectsOptional
List of built-in tools associated with this Config.
event_messages
objectOptional

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.

timeouts
objectOptional

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.

Built with