Skip to main content
POST
Create a monitoring prompt
Required scopes: read, write.

Authorizations

x-chatobserver-key
string
header
required

A workspace API key. Data endpoints require a service-account key with the specified scopes.

Headers

Idempotency-Key
string

Unique key for one logical command. Reuse it only when retrying the same request and payload.

Maximum string length: 255

Body

application/json
promptText
string
required

Leading and trailing whitespace is removed before validation.

Required string length: 1 - 399
schedule
object

Weekly schedules require at least one day (0 is Sunday). Non-weekly schedules must omit daysOfWeek or use null or an empty array.

description
null | string
Maximum string length: 4000
personaIds
string[]
Maximum array length: 50
Minimum string length: 1
targetPlatforms
enum<string>[]
Required array length: 1 - 6 elements
Available options:
chatgpt,
ai_overview,
ai_mode,
gemini,
perplexity,
claude
targetRegions
enum<string>[]
Minimum array length: 1
Available options:
United States,
Canada,
Brazil,
Mexico,
United Kingdom,
Germany,
France,
Spain,
Italy,
Netherlands,
India,
South Korea,
Japan,
Australia,
Singapore,
Switzerland,
United Arab Emirates,
Saudi Arabia,
Poland
tagIds
string[]
Maximum array length: 50
Minimum string length: 1

Response

Created successfully.

data
object
required