For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Start buildingGet support
DocumentationAPI ReferenceChangelogDiscord
  • Voices
    • POSTCreate voice
    • GETList voices
    • DELDelete voice
  • Text-to-Speech (TTS)
    • WSSStream Input
    • STREAMText-to-Speech (Streamed JSON)
    • POSTText-to-Speech (Streamed File)
    • POSTText-to-Speech (Json)
    • POSTText-to-Speech (File)
    • POSTVoice Conversion (Streamed File)
    • STREAMVoice Conversion (Streamed JSON)
  • Speech-to-speech (EVI)
    • WSSChat
      • POSTCreate prompt
      • GETList prompts
      • GETList prompt versions
      • GETGet prompt version
      • POSTCreate prompt version
      • PATCHUpdate prompt name
      • PATCHUpdate prompt description
      • DELDelete prompt
      • DELDelete prompt version
  • Expression Measurement API
Start buildingGet support
LogoLogo
LogoLogo
Speech-to-speech (EVI)Prompts

Update prompt description

PATCH
https://api.hume.ai/v0/evi/prompts/:id/version/:version
PATCH
/v0/evi/prompts/:id/version/:version
$curl -X PATCH https://api.hume.ai/v0/evi/prompts/your-prompt-id/version/1 \
>     -H "X-Hume-Api-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "version_description": "This is an updated version_description."
>}'
200Updated
1{
2  "created_on": 1722633247488,
3  "id": "af699d45-2985-42cc-91b9-af9e5da3bac5",
4  "modified_on": 1722634770585,
5  "name": "string",
6  "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>",
7  "version": 1,
8  "version_type": "FIXED",
9  "version_description": "This is an updated version_description."
10}

Updates the description of a Prompt.

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

Was this page helpful?
Previous

Delete prompt

Next
Built with

Authentication

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

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.

Request

This endpoint expects an object.
version_descriptionstring or nullOptional
An optional description of the Prompt version.

Response

Success
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_expansionobject
Configuration for prompt expansion behavior.
version_descriptionstring or null
An optional description of the Prompt version.