Skip to main content
GET
/
v1
/
public
/
prompts
/
{prompt_name}
Get Prompt
curl --request GET \
  --url https://api.eigi.ai/v1/public/prompts/{prompt_name} \
  --header 'X-API-Key: <api-key>'
{
  "prompt_name": "<string>",
  "prompt_version": 123,
  "prompt_content": "<string>",
  "prompt_metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

​
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

​
X-API-Key
string
required
Your eigi.ai API key. Must be prefixed with vk_.

​
Path Parameters

​
prompt_name
string
required
The unique prompt name.Example: customer_support_v1

​
Query Parameters

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

​
Response

​
prompt_name
string
The unique prompt name.
​
prompt_version
integer
Version number of the returned prompt.
​
prompt_content
string
The prompt text content.
​
prompt_metadata
object
Metadata including prompt_type.
​
created_at
string
ISO 8601 creation timestamp.
​
updated_at
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