Skip to main content
GET
Get Prompt

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Path Parameters

id
string<uuid>
required

Prompt ID

Response

Default Response

id
string<uuid>
required

Prompt identifier

prompt
string
required

The prompt text

type
enum<string>
required

Type of prompt

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
isActive
boolean
required

Whether the prompt is active

languageCode
string
required

Language code for the prompt

llmMonitorId
string<uuid>
required

Monitor that owns this prompt

llmMonitor
object
required
amountOfResponses
number
required

Total number of responses for this prompt

volume
number | null
required

Weighted search volume across all keywords (Google + Bing + AI). Null if no keyword data available.

createdAt
string<date-time>
required

Prompt creation timestamp

updatedAt
string<date-time>
required

Prompt last update timestamp

intent
enum<string> | null

Intent of the prompt

Available options:
BRANDED,
INFORMATIONAL,
NAVIGATIONAL,
COMMERCIAL,
TRANSACTIONAL
averageVisibility
number | null

Average visibility score across all responses

difficulty
number | null

Weighted average keyword difficulty across all keywords