Update prompt description | Hume API

Updates the Description of a Prompt.

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

Authentication

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

Path Parameters

id
string Required format: "uuid"
Identifier for a Prompt. Formatted as a UUID.

version
integer Required
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.

Request

This endpoint expects an object.

version_description
string or null Optional
An optional description of the Prompt version.

Response

Success
created_on
long
Time at which the Prompt was created. Measured in seconds since the Unix epoch.

id
string
Identifier for a Prompt. Formatted as a UUID.

modified_on
long
Time at which the Prompt was last modified. Measured in seconds since the Unix epoch.

name
string
Name applied to all versions of a particular Prompt.

text
string
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
integer
Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique.

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

prompt_expansion
object
Configuration for prompt expansion behavior.