Skip to main content
POST
Create Prompt

Overview

Create a new prompt for use with your AI agents. If a prompt with the same name already exists, a new version is automatically created with an incremented version number. Prompts support two types:
  • main — Used as the agent’s system prompt / instructions
  • analysis — Used for post-conversation analysis

Authentication

string
required
Your eigi.ai API key. Must be prefixed with vk_.

Request Body

string
required
Unique prompt name (1-100 characters). If a prompt with this name exists, a new version is created.
string
required
The prompt text content — the instructions or system message for your agent.
object
Optional metadata for the prompt.

Response

string
The unique prompt name.
integer
Version number (starts at 1, auto-increments for existing prompts).
string
The prompt text content.
object
Metadata including prompt_type.
string
ISO 8601 creation timestamp.
string
ISO 8601 last update timestamp.

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your API key from the eigi.ai Dashboard under Settings → API Keys.

Body

application/json
prompt_name
string
required

Unique prompt name (1-100 characters)

Required string length: 1 - 100
Example:

"customer_support_v1"

prompt_content
string
required

The prompt text content

Minimum string length: 1
Example:

"You are a helpful customer support agent for TechCorp. Be polite, professional, and solve customer issues efficiently."

prompt_metadata
object

Metadata for the prompt

Example:

Response

Prompt created successfully

prompt_name
string

Unique prompt name

prompt_version
integer

Version number of the prompt

prompt_content
string

The prompt text content

prompt_metadata
object

Additional metadata

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp