Skip to main content
POST
research.monitor.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
query
string
required

The research question to watch, in plain words. Its answer is researched again on every check, and only the changes are reported.

Required string length: 1 - 2000
schema
object

Optional JSON Schema of the answer's fields to watch for changes: an object of 1-8 named scalar, enum or short-array fields, at most 8000 characters as JSON. Without it, the whole answer is compared as text.

quality
enum<string>
default:fast

"fast" researches cheaply; "standard" researches deeper and costs more per check. Default "fast". The first research costs $0.01 (fast) or $0.025 (standard) once, and every check after that bills at the schedule's cadence (at most $0.003 per check fast or $0.01 standard).

Available options:
fast,
standard
schedule
string

Five-field cron expression for the checks. Only a cadence that can be kept exactly is accepted: "0 * * * *" every hour, or every 2, 3, 4, 6, 8 or 12 hours as "0 */N * * *". The checks run every N hours counted from the moment the monitor is created, not at fixed clock times; a fixed hour, a weekday, a day of the month or a time zone is not accepted. Default: every 12 hours.

Maximum string length: 120
name
string

A label for the monitor.

Required string length: 1 - 100

Response

The result

query
string
required

The research question being watched.

schedule
string
required

Five-field cron expression the checks run on.

name
string

The monitor's label.

status
enum<string>

The monitor is running.

Available options:
active
createdAt
string

When the monitor was created, ISO 8601.

ref
string

Reference to what this call created. Pass it as ref to web.monitor.delete, web.monitor.events, web.monitor.update and web.monitor.trigger.