Empathic Voice Interface (EVI)Prompts

Create prompt version

Updates a Prompt by creating a new version of the Prompt.

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

Path parameters

idstringRequiredformat: "uuid"
Identifier for a Prompt. Formatted as a UUID.

Headers

X-Hume-Api-KeystringRequired

Request

This endpoint expects an object.
textstringRequired

Instructions used to shape EVI’s behavior, responses, and style for this version of the Prompt.

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. Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed. Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
version_typeenum

Versioning method for a Prompt. Either FIXED for using a fixed version number or LATEST for auto-updating to the latest version.

Allowed values:
namestring
Name applied to all versions of a particular Prompt.
created_onlong
Time at which the Prompt was created. Measured in seconds since the Unix epoch.
modified_onlong
Time at which the Prompt was last modified. Measured in seconds since the Unix epoch.
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.

version_descriptionstring or null
An optional description of the Prompt version.