Skip to main content
POST
Create Monitor

Authorizations

X-API-Key
string
header
required

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

Body

application/json
name
string
required

Monitor name

Minimum string length: 1
models
string[]
required

List of LLM models to monitor

Minimum array length: 1
description
string | null

Monitor description

languageCode
string
default:en-US

Language code

countryCode
string
default:US

Country code

stateCode
string | null

State code

cityCode
string | null

City code

promptFrequency
enum<string> | null

Monitor-level tracking frequency override (requires the Custom Prompt Frequency feature, Business plan and above). Omit or null to inherit the organization's plan frequency.

Available options:
DAILY,
EVERY_OTHER_DAY,
WEEKLY,
MONTHLY,
null
personaId
string<uuid> | null

Persona ID

personaStackingEnabled
boolean

Inject the persona's stackable prompt around each tracked prompt at run time

initialPrompts
object[]

Initial prompts to create with the monitor

generatePrompts
object[]

Optional array of generation batches (max 3, one per prompt type). Each entry triggers one independent call to the prompt generator (batches run in parallel; no prompt text from other batches or from initialPrompts is passed as context). Per-entry amount is 1-50; the sum across all entries must also be <= 50.

Maximum array length: 3

Response

Default Response

id
string<uuid>
required

Monitor unique identifier

name
string
required

Monitor name

active
boolean
required

Whether the monitor is active

models
string[]
required

List of LLM models being monitored

languageCode
string
required

Language code for the monitor

countryCode
string
required

Country code for the monitor

promptCount
number
required

Number of prompts in this monitor

responseCount
number
required

Total number of responses across all prompts

averageVisibility
number
required

Average visibility score for the monitor within the selected date range

createdAt
string<date-time>
required

Monitor creation timestamp

updatedAt
string<date-time>
required

Monitor last update timestamp

description
string | null

Monitor description

promptFrequency
enum<string> | null

Monitor-level tracking frequency override. Null inherits the organization's plan frequency.

Available options:
DAILY,
EVERY_OTHER_DAY,
WEEKLY,
MONTHLY
responseCountInRange
number

Number of responses created within the selected date range

personaName
string | null

Persona name used for the monitor

personaDescription
string | null

Persona description

personaAgeRange
string | null

Persona age range

personaEducationLevel
string | null

Persona education level