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 or null

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

ellm_modelobject or null

A specific eLLM Model configuration

event_messagesobject or null

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 or null

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.

Specifies the EVI version to use. See our [EVI Version Guide](/docs/speech-to-speech-evi/configuration/evi-version) 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](/docs/speech-to-speech-evi/configuration/evi-version#migrating-to-evi-3) before then.

idstring or null

Identifier for a Config. Formatted as a UUID.

language_modelobject or null

A specific LanguageModel

modified_onlong or null

Time at which the Config was last modified. Measured in seconds since the Unix epoch.

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 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.

versioninteger or null

version_descriptionstring or null

An optional description of the Config version.

voiceobject or null

An Octave voice available for text-to-speech

webhookslist of objects or null

Map of webhooks associated with this config.

1	curl -X PATCH https://api.hume.ai/v0/evi/configs/1b60e1a0-cc59-424a-8d2c-189d354db3f3/version/1 \
2	-H "X-Hume-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"version_description": "This is an updated version_description."
6	}'

1	{
2	"builtin_tools": [],
3	"created_on": 1715275452390,
4	"ellm_model": {
5	"allow_short_responses": false
6	},
7	"event_messages": {
8	"on_inactivity_timeout": {
9	"enabled": false,
10	"text": ""
11	},
12	"on_max_duration_timeout": {
13	"enabled": false,
14	"text": ""
15	},
16	"on_new_chat": {
17	"enabled": false,
18	"text": ""
19	}
20	},
21	"evi_version": "3",
22	"id": "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
23	"language_model": {
24	"model_provider": "ANTHROPIC",
25	"model_resource": "claude-3-7-sonnet-latest",
26	"temperature": 1
27	},
28	"modified_on": 1715275452390,
29	"name": "Weather Assistant Config",
30	"prompt": {
31	"created_on": 1715267200693,
32	"id": "af699d45-2985-42cc-91b9-af9e5da3bac5",
33	"modified_on": 1715267200693,
34	"name": "Weather Assistant Prompt",
35	"text": "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
36	"version": 0,
37	"version_type": "FIXED",
38	"version_description": ""
39	},
40	"timeouts": {
41	"inactivity": {
42	"enabled": true,
43	"duration_secs": 600
44	},
45	"max_duration": {
46	"enabled": true,
47	"duration_secs": 1800
48	}
49	},
50	"tools": [],
51	"version": 1,
52	"version_description": "This is an updated version_description.",
53	"voice": {
54	"id": "5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c",
55	"name": "Ava Song",
56	"provider": "HUME_AI"
57	}
58	}