Skip to main content
POST
/
v0
/
monitors
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": {
      "query": "<string>",
      "criteria": [
        {
          "description": "<string>"
        }
      ],
      "entity": {
        "type": "company"
      },
      "count": 123,
      "behavior": "append"
    }
  },
  "metadata": {}
}'
{
  "id": "<string>",
  "object": "monitor",
  "status": "enabled",
  "websetId": "<string>",
  "cadence": {
    "cron": "<string>",
    "timezone": "Etc/UTC"
  },
  "behavior": {
    "type": "search",
    "config": {
      "query": "<string>",
      "criteria": [
        {
          "description": "<string>"
        }
      ],
      "entity": {
        "type": "company"
      },
      "count": 123,
      "behavior": "append"
    }
  },
  "lastRun": {
    "id": "<string>",
    "object": "monitor_run",
    "status": "created",
    "monitorId": "<string>",
    "type": "search",
    "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

x-api-key
string
header
required

Your Exa API key

Body

application/json
websetId
string
required

The id of the Webset

cadence
object
required

How often the monitor will run

behavior
object
required

Behavior to perform when monitor runs

metadata
object

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

behavior
object
required

Behavior to perform when monitor runs

lastRun
object
required

The last run of the monitor

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.

createdAt
string<date-time>
required

When the monitor was created

updatedAt
string<date-time>
required

When the monitor was last updated

I