Speech-to-speech (EVI)Configs

Create config

Authentication

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

Request

This endpoint expects an object.
evi_versionstringRequired
The version of the EVI used with this config.
namestringRequired
Name applied to all versions of a particular Config.
builtin_toolslist of objects or nullOptional

Built-in tool specification for a Config.

ellm_modelobjectOptional
A eLLM model configuration to be posted to the server
event_messagesobjectOptional

Collection of event_message specs to be posted to the server

language_modelobjectOptional
A LanguageModel to be posted to the server
nudgesobjectOptional
A nudge specification posted to the server
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 specs to be posted to the server
toolslist of objects or nullOptional
Tool specification for a Config.
version_descriptionstring or nullOptional
Description that is appended to a specific version of a Config.
voiceobjectOptional
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_message specs to be returned from the server

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 specs to be returned from the server
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.