Create a Monitor

Creates a new Monitor to continuously keep your Websets updated with fresh data.

Monitors automatically run on your defined schedule to ensure your Websets stay current without manual intervention:

• Find new content: Execute search operations to discover fresh items matching your criteria
• Update existing content: Run refresh operations to update items contents and enrichments
• Automated scheduling: Configure cron expressions and timezone for precise scheduling control

POST /v0/monitors

cURL

cURL

curl --request POST \
  --url https://api.exa.ai/websets/v0/monitors \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "websetId": "<string>",
  "cadence": {
    "cron": "<string>",
    "timezone": "Etc/UTC"
  },
  "behavior": {
    "type": "search",
    "config": {
      "count": 123,
      "query": "<string>",
      "criteria": [
        {
          "description": "<string>"
        }
      ],
      "entity": {
        "type": "company"
      },
      "behavior": "append"
    }
  },
  "metadata": {}
}
'

201

{
  "id": "<string>",
  "websetId": "<string>",
  "cadence": {
    "cron": "<string>",
    "timezone": "Etc/UTC"
  },
  "behavior": {
    "type": "search",
    "config": {
      "count": 123,
      "query": "<string>",
      "criteria": [
        {
          "description": "<string>"
        }
      ],
      "entity": {
        "type": "company"
      },
      "behavior": "append"
    }
  },
  "lastRun": {
    "id": "<string>",
    "monitorId": "<string>",
    "completedAt": "2023-11-07T05:31:56Z",
    "failedAt": "2023-11-07T05:31:56Z",
    "failedReason": "<string>",
    "canceledAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "nextRunAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

apiKeybearer

x-api-key · string · header · required

Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .

Body

application/json

websetId · string · required

The id of the Webset

cadence · object · required

How often the monitor will run

Show child attributes

behavior · object · required

Behavior to perform when monitor runs

Show child attributes

metadata · object

Show child attributes

Response

201 - application/json

Monitor created successfully

id · string · required

The unique identifier for the Monitor

object · enum<string> · required

The type of object

Available options: monitor

status · enum<string> · required

The status of the Monitor

Available options: enabled, disabled

websetId · string · required

The id of the Webset the Monitor belongs to

cadence · object · required

How often the monitor will run

Show child attributes

behavior · object · required

Behavior to perform when monitor runs

Show child attributes

lastRun · MonitorRun · object · required

The last run of the monitor

Show child attributes

nextRunAt · string<date-time> | null · required

Date and time when the next run will occur in

metadata · object · required

Set of key-value pairs you want to associate with this object.

Show child attributes

createdAt · string<date-time> · required

When the monitor was created

updatedAt · string<date-time> · required

When the monitor was last updated