Filter to only include tools with this name.

List tools

Create tool

Identifier for a Tool. Formatted as a UUID.

List tool versions

Create tool version

Delete tool

Update tool name

Get tool version

Delete tool version

Update tool description

Tools

Filter to only include prompts with this name.

List prompts

Create prompt

Identifier for a Prompt. Formatted as a UUID.

List prompt versions

Create prompt version

Delete prompt

Update prompt name

Get prompt version

Delete prompt version

Update prompt description

Prompts

Filter to only include custom voices with this name.

List custom voices

Create custom voice

Identifier for a Custom Voice. Formatted as a UUID.

Get specific custom voice by ID

Create new version of existing custom voice

Delete a custom voice

Update custom voice name

Custom Voices

Filter to only include configs with this name.

List configs

Create config

Identifier for a Config. Formatted as a UUID.

List config versions

Create config version

Delete config

Update config name

Get config version

Delete config version

Update config description

Configs

Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.

List chats

Identifier for a Chat. Formatted as a UUID.

List chat events

Chats

List chat_groups

Identifier for a Chat Group. Formatted as a UUID.

Get chat_group

List chat events from a specific chat_group

Chat Groups

Chat

When provided, the output is an assistant end message.

AssistantEnd

Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions.

When provided, the input is spoken by EVI.

AssistantInput

When provided, the output is an assistant message.

AssistantMessage

ID of the assistant message. Allows the Assistant Message to be tracked and referenced.

AudioConfiguration

Audio sample rate. Number of samples per second in the audio input, measured in Hertz.

AudioInput

AudioOutput

ID of the audio output. Allows the Audio Output message to be tracked and referenced.

Index of the chunk of audio relative to the whole audio segment.

Base64 encoded audio output. This encoded audio is transmitted to the client, where it can be decoded and played back as part of the user interaction.

BuiltInTool

BuiltinToolConfig

Optional text passed to the supplemental LLM if the tool call fails. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation.

ChatMessage

ChatMessageToolResult

When provided, the output is a chat metadata message.

ChatMetadata

ID of the Chat session. Allows the Chat session to be tracked and referenced.

Context

ContextType

EmotionScores

Encoding

ErrorLevel

ErrorResponse

ExtendedVoiceArgs

FunctionCallResponseInput

HTTPValidationError

Inference

JsonMessage

MillisecondInterval

Start time of the interval in milliseconds.

End time of the interval in milliseconds.

Pause responses from EVI. Chat history is still saved and sent after resuming.

PauseAssistantMessage

A configuration of a built-in tool to be posted to the server

PostedBuiltinTool

Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors.

PostedBuiltinToolName

Identifies which prompt to use in a a config OR how to create a new prompt to use in the config

PostedConfigPromptSpec

Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique.

Text used to create a new prompt for a particular config.

PostedCustomVoice

The name of the Custom Voice. Maximum length of 75 characters. Will be converted to all-uppercase. (e.g., "sample voice" becomes "SAMPLE VOICE")

Specifies the base voice used to create the Custom Voice.

PostedCustomVoiceBaseVoice

PostedCustomVoiceParameters

A eLLM model configuration to be posted to the server

PostedEllmModel

PostedEventMessageSpec

Text to use as the event message when the corresponding event occurs. If no text is specified, EVI will generate an appropriate message based on its current context and the system prompt.

PostedEventMessageSpecs

Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message.

Specifies the message EVI provides when the chat is disconnected due to reaching the maximum chat duration, such as a message mentioning the time limit for the chat has been reached.

A LanguageModel to be posted to the server

PostedLanguageModel

The provider of the supplemental language model.

PostedLanguageModelModelProvider

PostedPromptSpec

Settings for a specific timeout to be posted to the server

PostedTimeoutSpec

Boolean indicating if this event message is enabled.

PostedTimeoutSpecs

PostedTimeoutSpecsInactivity

Duration in seconds for the timeout (e.g. 600 seconds represents 10 minutes).

PostedTimeoutSpecsMaxDuration

A specific tool identifier to be posted to the server

PostedUserDefinedToolSpec

A Voice specification posted to the server

PostedVoice

ProsodyInference

Resume responses from EVI. Chat history sent while paused will now be sent.

ResumeAssistantMessage

A description of current chat chat sessions for a user

ReturnActiveChatCount

The timestamp for when chat status was measured. Formatted as a Unix epoch milliseconds.

The total number of active chats for this user.

The maximum number of concurrent active chats for this user.

Boolean indicating if the user is allowed to start more chats.

A description of current chat chat sessions per tag

ReturnActiveChatCountPerTag

The total number of active chats for this user with the specified tag.

A specific builtin tool version returned from the server

ReturnBuiltinTool

Name applied to all versions of a particular Tool.

ReturnBuiltinToolToolType

ReturnChat

Time at which the Chat started. Measured in seconds since the Unix epoch.

Time at which the Chat ended. Measured in seconds since the Unix epoch.

The total number of events currently in this chat.

Stringified JSON with additional metadata about the chat.

A description of a single event in a chat returned from the server

ReturnChatEvent

Identifier for a Chat Event. Formatted as a UUID.

Identifier for the Chat this event occurred in. Formatted as a UUID.

Time at which the Chat Event occurred. Measured in seconds since the Unix epoch.

Stringified JSON with additional metadata about the chat event.

ReturnChatEventRole

ReturnChatEventType

ReturnChatGroup

Time at which the first Chat in this Chat Group was created. Measured in seconds since the Unix epoch.

Time at which the most recent Chat in this Chat Group was created. Measured in seconds since the Unix epoch.

The total number of Chats in this Chat Group.

Denotes whether there is an active Chat associated with this Chat Group.

ReturnChatGroupPagedChats

The total number of Chats associated with this Chat Group.

The total number of pages in the collection.

ReturnChatGroupPagedChatsPaginationDirection

ReturnChatGroupPagedEvents

ReturnChatGroupPagedEventsPaginationDirection

A description of chat status with a paginated list of chat events returned from the server

ReturnChatPagedEvents

ReturnChatPagedEventsPaginationDirection

ReturnChatPagedEventsStatus

ReturnChatStatus

A specific config version returned from the server

ReturnConfig

An optional description of the Config version.

Name applied to all versions of a particular Config.

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

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

A voice specification associated with this Config.

List of user-defined tools associated with this Config.

List of built-in tools associated with this Config.

ReturnConfigSpec

A Custom Voice specification associated with this Config.

ReturnCustomVoice

The name of the Custom Voice. Maximum length of 75 characters.

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

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

1	curl -X POST https://api.hume.ai/v0/evi/custom_voices \
2	-H "X-Hume-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "name",
6	"base_voice": "ITO",
7	"parameter_model": "20240715-4parameter"
8	}'

1	{
2	"id": "id",
3	"version": 1,
4	"name": "name",
5	"created_on": 1000000,
6	"modified_on": 1000000,
7	"base_voice": "ITO",
8	"parameter_model": "20240715-4parameter",
9	"parameters": {
10	"gender": 1,
11	"huskiness": 1,
12	"nasality": 1,
13	"pitch": 1
14	}
15	}

Request

Response