Skip to navigation
Speech-to-speech (EVI)Configs

List configs

Fetches a paginated list of Configs.

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

Query parameters

page_numberintegerOptionalDefaults to 0

Specifies the page number to retrieve, enabling pagination.

This parameter uses zero-based indexing. For example, setting page_number to 0 retrieves the first page of results (items 0-9 if page_size is 10), setting page_number to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.

page_sizeintegerOptional

Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.

For example, if page_size is set to 10, each page will include up to 10 items. Defaults to 10.

restrict_to_most_recentbooleanOptional

By default, restrict_to_most_recent is set to true, returning only the latest version of each config. To include all versions of each config in the list, set restrict_to_most_recent to false.

namestringOptional
Filter to only include configs with this name.

Response

Success
total_pagesinteger
The total number of pages in the collection.
configs_pagelist of objectsOptional

List of configs returned for the specified page_number and page_size.

builtin_toolslist of objects or nullOptional

List of built-in tools associated with this Config.

created_onlongOptional
Time at which the Config was created. Measured in seconds since the Unix epoch.
ellm_modelobjectOptional

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_messagesobjectOptional
Map of event messages associated with this config.
evi_versionstringOptional

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.

idstringOptional
Identifier for a Config. Formatted as a UUID.
interruptionobjectOptional
An interruption configuration returned from the server
language_modelobjectOptional

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.

modified_onlongOptional
Time at which the Config was last modified. Measured in seconds since the Unix epoch.
namestringOptional
Name applied to all versions of a particular Config.
nudgesobjectOptional
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.
promptobjectOptional
A Prompt associated with this Config.
timeoutsobjectOptional
Map of timeouts associated with this config.
toolslist of objects or nullOptional

List of user-defined tools associated with this Config.

turn_detectionobjectOptional
A turn detection configuration returned from the server
versionintegerOptional

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 nullOptional
An optional description of the Config version.
voiceobjectOptional
A voice specification associated with this Config.
webhookslist of objects or nullOptional
Map of webhooks associated with this config.
page_numberintegerOptional

The page number of the returned list.

This value corresponds to the page_number parameter specified in the request. Pagination uses zero-based indexing.

page_sizeintegerOptional

The maximum number of items returned per page.

This value corresponds to the page_size parameter specified in the request.