Send Message
Authentication
Path parameters
Request
Settings for this chat session. Session settings are temporary and apply only to the current Chat session.
These settings can be adjusted dynamically based on the requirements of each session to ensure optimal performance and user experience. See our Session Settings Guide for a complete list of configurable settings.
The type of message sent through the socket; must be session_settings for our server to correctly identify and process it as a Session Settings message.
Session settings are temporary and apply only to the current Chat session. These settings can be adjusted dynamically based on the requirements of each session to ensure optimal performance and user experience.
For more information, please refer to the Session Settings section on the EVI Configuration page.
Configuration details for the audio input used during the session. Ensures the audio is being correctly set up for processing.
This optional field is only required when the audio input is encoded in PCM Linear 16 (16-bit, little-endian, signed PCM WAV data). For detailed instructions on how to configure session settings for PCM Linear 16 audio, please refer to the Session Settings section on the EVI Configuration page.
List of built-in tools to enable for the session.
Tools are resources used by EVI to perform various tasks, such as searching the web or calling external APIs. Built-in tools, like web search, are natively integrated, while user-defined tools are created and invoked by the user. To learn more, see our Tool Use Guide.
Currently, the only built-in tool Hume provides is Web Search. When enabled, Web Search equips EVI with the ability to search the web for up-to-date information.
Field for injecting additional context into the conversation, which is appended to the end of user messages for the session.
When included in a Session Settings message, the provided context can be used to remind the LLM of its role in every user message, prevent it from forgetting important details, or add new relevant information to the conversation.
Set to null to clear injected context.
Unique identifier for the session. Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions.
If included, the response sent from Hume to your backend will include this ID. This allows you to correlate frontend users with their incoming messages.
It is recommended to pass a custom_session_id if you are using a Custom Language Model. Please see our guide to using a custom language model with EVI to learn more.
Instructions used to shape EVI’s behavior, responses, and style for the session.
When included in a Session Settings message, the provided Prompt overrides the existing one specified in the EVI configuration. If no Prompt was defined in the configuration, this Prompt will be the one used for the session.
You can use the Prompt to define a specific goal or role for EVI, specifying how it should act or what it should focus on during the conversation. For example, EVI can be instructed to act as a customer support representative, a fitness coach, or a travel advisor, each with its own set of behaviors and response styles.
For help writing a system prompt, see our Prompting Guide.
List of user-defined tools to enable for the session.
Tools are resources used by EVI to perform various tasks, such as searching the web or calling external APIs. Built-in tools, like web search, are natively integrated, while user-defined tools are created and invoked by the user. To learn more, see our Tool Use Guide.
This field allows you to assign values to dynamic variables referenced in your system prompt.
Each key represents the variable name, and the corresponding value is the specific content you wish to assign to that variable within the session. While the values for variables can be strings, numbers, or booleans, the value will ultimately be converted to a string when injected into your system prompt.
Using this field, you can personalize responses based on session-specific details. For more guidance, see our guide on using dynamic variables.
User text to insert into the conversation. Text sent through a User Input message is treated as the user’s speech to EVI. EVI processes this input and provides a corresponding response.
Expression measurement results are not available for User Input messages, as the prosody model relies on audio input and cannot process text alone.
The type of message sent through the socket; must be user_input for our server to correctly identify and process it as a User Input message.
Assistant text to synthesize into spoken audio and insert into the conversation. EVI uses this text to generate spoken audio using our proprietary expressive text-to-speech model.
Our model adds appropriate emotional inflections and tones to the text based on the user’s expressions and the context of the conversation. The synthesized audio is streamed back to the user as an Assistant Message.
Assistant text to synthesize into spoken audio and insert into the conversation.
EVI uses this text to generate spoken audio using our proprietary expressive text-to-speech model. Our model adds appropriate emotional inflections and tones to the text based on the user’s expressions and the context of the conversation. The synthesized audio is streamed back to the user as an Assistant Message.
The type of message sent through the socket; must be assistant_input for our server to correctly identify and process it as an Assistant Input message.
Return value of the tool call. Contains the output generated by the tool to pass back to EVI. Upon receiving a Tool Call message and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
For built-in tools implemented on the server, you will receive this message type rather than a ToolCallMessage. See our Tool Use Guide for further details.
The unique identifier for a specific tool call instance.
This ID is used to track the request and response of a particular tool invocation, ensuring that the correct response is linked to the appropriate request. The specified tool_call_id must match the one received in the Tool Call message.
The type of message sent through the socket; for a Tool Response message, this must be tool_response.
Upon receiving a Tool Call message and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
Error message from the tool call, not exposed to the LLM or user. Upon receiving a Tool Call message and failing to invoke the function, this message is sent to notify EVI of the tool’s failure.
For built-in tools implemented on the server, you will receive this message type rather than a ToolCallMessage if the tool fails. See our Tool Use Guide for further details.
The unique identifier for a specific tool call instance.
This ID is used to track the request and response of a particular tool invocation, ensuring that the Tool Error message is linked to the appropriate tool call request. The specified tool_call_id must match the one received in the Tool Call message.
The type of message sent through the socket; for a Tool Error message, this must be tool_error.
Upon receiving a Tool Call message and failing to invoke the function, this message is sent to notify EVI of the tool’s failure.
Indicates the severity of an error; for a Tool Error message, this must be warn to signal an unexpected event.
Type of tool called. Either builtin for natively implemented tools, like web search, or function for user-defined tools.
Pause responses from EVI. Chat history is still saved and sent after resuming. Once this message is sent, EVI will not respond until a Resume Assistant message is sent.
When paused, EVI won’t respond, but transcriptions of your audio inputs will still be recorded. See our Pause Response Guide for further details.
The type of message sent through the socket; must be pause_assistant_message for our server to correctly identify and process it as a Pause Assistant message.
Once this message is sent, EVI will not respond until a Resume Assistant message is sent. When paused, EVI won’t respond, but transcriptions of your audio inputs will still be recorded.
Resume responses from EVI. Chat history sent while paused will now be sent.
Upon resuming, if any audio input was sent during the pause, EVI will retain context from all messages sent but only respond to the last user message. See our Pause Response Guide for further details.
The type of message sent through the socket; must be resume_assistant_message for our server to correctly identify and process it as a Resume Assistant message.
Upon resuming, if any audio input was sent during the pause, EVI will retain context from all messages sent but only respond to the last user message. (e.g., If you ask EVI two questions while paused and then send a resume_assistant_message, EVI will respond to the second question and have added the first question to its conversation context.)