Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header. Note: A payment method is required to use the API.

Body

application/json

Request body for the Create Monitor API.

type
enum<string>
required

The monitor type. topic finds new content on a topic. page watches the given URLs for changes.

Available options:
topic,
page
topic
object

Search settings for a topic monitor. Required when type is topic.

page
object

Settings for a page monitor. Required when type is page.

name
string

The monitor name. Defaults to the query, or the domain and path of the first URL.

Maximum string length: 256
condition
string | null

When to notify, in natural language, such as price drops more than 10%. An empty string or null means no condition.

Without a condition, the first run notifies once with change_status set to baseline. After that, a topic monitor notifies for each new relevant result; a page monitor notifies when any output_schema field changes or, without output_schema, when a model judges the page change meaningful.

Maximum string length: 1000
schedule
object

How often the monitor runs.

webhook
object

Where to push events.

email
object

Email notifications. Each run's events are sent as one email.

metadata
object

Your own key-value pairs, returned as-is in responses and webhooks. Up to 8 pairs; keys up to 16 characters, string values up to 512 characters.

Response

Successful monitor creation response

request_id
string
required

The unique identifier for this request.

code
integer

Business status code. 0 indicates success.

msg
string

A message describing the result.

data
object