Get Prompt

Retrieve a specific prompt with its versions

Endpoint

method · string · default: "POST"

POST

endpoint · string

/v1/prompt/{promptId}/query

Authentication

This endpoint requires API key authentication. Include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY

Path Parameters

promptId · string · required

The unique identifier of the prompt

Request Body

timeFilter · object · required

Time range to filter prompt usage

start · string · required

Start time in ISO 8601 format

end · string · required

End time in ISO 8601 format

Response

data · object

Prompt details

id · string

Unique identifier for the prompt

user_defined_id · string

User-defined identifier

description · string

Prompt description

pretty_name · string

Display name for the prompt

major_version · number

Current major version number

latest_version_id · string

ID of the latest prompt version

latest_model_used · string

Most recently used model for this prompt

created_at · string

Prompt creation timestamp

last_used · string

Timestamp of last usage

versions · array

Array of version IDs

metadata · object

Additional metadata

error · string | null

Error message if the request failed, null otherwise

Example Request

curl -X POST https://api.helicone.ai/v1/prompt/prompt_abc123/query \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeFilter": {
      "start": "2024-01-01T00:00:00Z",
      "end": "2024-01-31T23:59:59Z"
    }
  }'

Example Response

{
  "data": {
    "id": "prompt_abc123",
    "user_defined_id": "customer-support-v1",
    "description": "Customer support prompt template",
    "pretty_name": "Customer Support",
    "major_version": 2,
    "latest_version_id": "pv_xyz789",
    "latest_model_used": "gpt-4",
    "created_at": "2024-01-01T10:00:00Z",
    "last_used": "2024-01-30T15:30:00Z",
    "versions": ["pv_xyz789", "pv_xyz788"],
    "metadata": {
      "department": "support"
    }
  },
  "error": null
}