Speech-to-speech (EVI)Prompts

Create prompt

Creates a Prompt that can be added to an EVI configuration.

See our prompting guide for tips on crafting your system prompt.

Authentication

X-Hume-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequired
Name applied to all versions of a particular Prompt.
textstringRequired

Instructions used to shape EVI’s behavior, responses, and style.

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.

prompt_expansionobjectOptional
Configuration for prompt expansion behavior.
enabledbooleanOptional

Boolean indicating whether prompt expansion is enabled.

Defaults to true. When set to false, no additional instructions are appended to the system prompt, giving full control over the prompt content. Only applicable when using an external supplemental language model.

version_descriptionstring or nullOptional
An optional description of the Prompt version.

Response

Created
created_onlong
Time at which the Prompt was created. Measured in seconds since the Unix epoch.
idstring
Identifier for a Prompt. Formatted as a UUID.
modified_onlong
Time at which the Prompt was last modified. Measured in seconds since the Unix epoch.
namestring
Name applied to all versions of a particular Prompt.
textstring

Instructions used to shape EVI’s behavior, responses, and style.

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.

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

Indicates whether this prompt is using a fixed version number or auto-updating to the latest version. Values from the VersionType enum.

prompt_expansionobjectOptional
Configuration for prompt expansion behavior.
enabledbooleanOptional

Boolean indicating whether prompt expansion is enabled.

Defaults to true. When set to false, no additional instructions are appended to the system prompt, giving full control over the prompt content. Only applicable when using an external supplemental language model.

version_descriptionstring or nullOptional
An optional description of the Prompt version.