Create prompt | Hume API

Creates a Prompt that can be added to an EVI configuration.

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

Authentication

X-Hume-Api-Keystring

API Key authentication via header

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.

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](/docs/speech-to-speech-evi/guides/prompting).

version_descriptionstring or nullOptional

An optional description of the Prompt version.

Response

Created

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.

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.

version_descriptionstring or null

An optional description of the Prompt version.

1	curl -X POST https://api.hume.ai/v0/evi/prompts \
2	-H "X-Hume-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Weather Assistant Prompt",
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	}'

1	{
2	"created_on": 1722633247488,
3	"id": "af699d45-2985-42cc-91b9-af9e5da3bac5",
4	"modified_on": 1722633247488,
5	"name": "Weather Assistant Prompt",
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": 0,
8	"version_type": "FIXED",
9	"version_description": null
10	}