Skip to main content
GET
/
prompts
/
{id}
Get Prompt
curl --request GET \
  --url https://server.promptwatch.com/api/v1/prompts/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompt": "<string>",
  "isActive": true,
  "languageCode": "<string>",
  "llmMonitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "llmMonitor": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "amountOfResponses": 123,
  "volume": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "averageVisibility": 123,
  "difficulty": 123
}

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 unique 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

Associated monitor ID

​
llmMonitor
object
required
​
amountOfResponses
number
required

Total number of responses for this prompt

​
volume
number
required

Weighted search volume across all keywords (Google + Bing + AI)

​
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