Skip to main content
GET
/
v1
/
public
/
prompts
List Prompts
curl --request GET \
  --url https://api.eigi.ai/v1/public/prompts \
  --header 'X-API-Key: <api-key>'
{
  "prompts": [
    {
      "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"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

​
Overview

List all prompts owned by the API key holder with pagination and search. By default, returns only the latest version of each prompt.

​
Authentication

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

​
Query Parameters

​
page
integer
default:"1"
Page number (minimum: 1).
​
page_size
integer
default:"10"
Items per page (minimum: 1, maximum: 100).
​
search
string
Search in prompt name and content.
​
latest_only
boolean
default:"true"
When true, returns only the latest version of each prompt.

​
Response

​
prompts
array
Array of prompt objects, each containing prompt_name, prompt_version, prompt_content, prompt_metadata, created_at, and updated_at.
​
total
integer
Total number of prompts matching the criteria.
​
page
integer
Current page number.
​
page_size
integer
Number of items per page.
​
total_pages
integer
Total number of pages available.

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
page_size
integer
default:10

Items per page (max: 100)

Required range: 1 <= x <= 100
​
search
string

Search in prompt name and content

​
latest_only
boolean
default:true

Return only latest versions

Response

Successfully retrieved prompts

​
prompts
object[]
​
total
integer
​
page
integer
​
page_size
integer
​
total_pages
integer