Update prompt description

Updates the description of a Prompt.

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

Path parameters

idstringRequiredformat: "uuid"

Identifier for a Prompt. Formatted as a UUID.

versionintegerRequired

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.

Headers

X-Hume-Api-KeystringRequired

Request

This endpoint expects an object.

version_descriptionstringOptional

An optional description of the Prompt version.

Response

Success

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.

1	from hume import HumeClient
2
3	client = HumeClient(
4	api_key="YOUR_API_KEY",
5	)
6	client.empathic_voice.prompts.update_prompt_description(
7	id="af699d45-2985-42cc-91b9-af9e5da3bac5",
8	version=1,
9	version_description="This is an updated version_description.",
10	)

1	{
2	"id": "af699d45-2985-42cc-91b9-af9e5da3bac5",
3	"version": 1,
4	"version_type": "FIXED",
5	"name": "string",
6	"created_on": 1722633247488,
7	"modified_on": 1722634770585,
8	"text": "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
9	"version_description": "This is an updated version_description."
10	}