Prompts

Create prompt

POST

Request

This endpoint expects an object.
name
stringRequired
Name applied to all versions of a particular Prompt.
text
stringRequired

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_description
stringOptional
An optional description of the Prompt version.

Response

This endpoint returns an optional object
id
string
Identifier for a Prompt. Formatted as a UUID.
version
integer

Version number for a Prompt.

Prompts, as well as Configs 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_type
enum

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

Allowed values: FIXEDLATEST
name
string
Name applied to all versions of a particular Prompt.
created_on
integer
Time at which the Prompt was created. Measured in seconds since the Unix epoch.
modified_on
integer
Time at which the Prompt was last modified. Measured in seconds since the Unix epoch.
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_description
stringOptional
An optional description of the Prompt version.
Built with