Skip to main content
GET
Get Prompt

Overview

Get the details of a specific prompt by its unique name. Returns the latest version by default, or a specific version if the version query parameter is provided.

Authentication

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

Path Parameters

string
required
The unique prompt name.Example: customer_support_v1

Query Parameters

integer
Specific version number to retrieve (minimum: 1). Omit to get the latest version.

Response

string
The unique prompt name.
integer
Version number of the returned prompt.
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.

Path Parameters

prompt_name
string
required

The unique prompt name

Query Parameters

version
integer

Specific version to retrieve (omit for latest)

Required range: x >= 1

Response

Successfully retrieved prompt

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