Create config | Hume API

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_version (string, Required): EVI version to use. Only versions 3 and 4-mini are supported.

• name (string, Required): Name applied to all versions of a particular Config.

• builtin_tools (list of objects or null, Optional): Built-in tool specification for a Config.

• ellm_model (object, Optional): 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_messages (object, Optional): Map of event messages associated with this config.

• interruption (object, Optional): An interruption specification posted to the server.

• language_model (object, Optional): 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.

• nudges (object, Optional): 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.

• prompt (object, Optional): A Prompt associated with this Config.

• timeouts (object, Optional): Map of timeouts associated with this config.

• tools (list of objects or null, Optional): Tool specification for a Config.

• turn_detection (object, Optional): A turn detection specification posted to the server.

• version_description (string or null, Optional): An optional description of the Config version.

• voice (object, Optional): A voice specification associated with this Config.

• webhooks (list of objects or null, Optional): Webhook config specifications for each subscriber.

Response

• Created
  • builtin_tools (list of objects or null): List of built-in tools associated with this Config.
  • created_on (long): Time at which the Config was created. Measured in seconds since the Unix epoch.
  • ellm_model (object): A specific eLLM Model configuration.
  • event_messages (object): 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_version (string): 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.

• id (string): Identifier for a Config. Formatted as a UUID.
• interruption (object): An interruption configuration returned from the server.
• language_model (object): A specific LanguageModel.
• modified_on (long): Time at which the Config was last modified. Measured in seconds since the Unix epoch.
• name (string): Name applied to all versions of a particular Config.
• nudges (object): A specific nudge configuration returned from the server.
• prompt (object): A specific prompt version returned from the server.
• timeouts (object): 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.

• tools (list of objects or null): List of user-defined tools associated with this Config.
• turn_detection (object): A turn detection configuration returned from the server.
• version (integer): 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_description (string or null): An optional description of the Config version.
• voice (object): An Octave voice available for text-to-speech.
• webhooks (list of objects or null): Map of webhooks associated with this config.