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.

Headers

X-Hume-Api-KeystringRequired

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.

version_descriptionstringOptional
An optional description of the Prompt version.

Response

Created
idstring
Identifier for a Prompt. Formatted as a UUID.
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.

namestring
Name applied to all versions of a particular Prompt.
created_onlong
The timestamp when the first version of this prompt was created.
modified_onlong
The timestamp when this version of the prompt was created.
textstring
Text used for this version of the Prompt.
version_descriptionstring or null
Description that is appended to a specific version of a Prompt.