Create a monitor

Creates a Monitor that runs an Exa search on a schedule and sends new results to your webhook. Each run searches recent content and drops results that match what earlier runs already returned, so your webhook receives only new developments.

The response includes a webhookSecret for verifying webhook signatures. It is returned only once, so store it securely.

cURL

cURL

curl -X POST https://api.exa.ai/monitors \
  -H "x-api-key: $EXA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

201

{
  "id": "<string>",
  "name": "<string>",
  "status": "active",
  "search": {
    "query": "<string>",
    "numResults": 10,
    "includeDomains": [
      "<string>"
    ],
    "excludeDomains": [
      "<string>"
    ],
    "contents": {
      "text": false,
      "highlights": false,
      "summary": true,
      "extras": {
        "links": 0,
        "imageLinks": 0,
        "richImageLinks": 0,
        "richLinks": 0,
        "codeBlocks": 0
      },
      "livecrawl": "never",
      "livecrawlTimeout": 10000,
      "maxAgeHours": 359,
      "filterEmptyResults": true,
      "subpages": 0,
      "subpageTarget": "<string>",
      "context": true
    }
  },
  "trigger": {
    "type": "interval",
    "period": "<string>"
  },
  "outputSchema": {
    "type": "text",
    "description": "<string>"
  },
  "metadata": {},
  "webhook": {
    "url": "<string>",
    "events": [
      "monitor.created"
    ]
  },
  "nextRunAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "webhookSecret": "<string>"
}

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

search · object · required

Show child attributes

webhook · object · required

Show child attributes

name · string

An optional name for the monitor

trigger · object

Show child attributes

outputSchema · object

Controls the format of the run output. Defaults to { "type": "text" } if not specified. When type is "text", the output is a plain text summary. When type is "object", the output is structured JSON. If no properties are specified with "object" type, a schema is inferred automatically; otherwise the output adheres to the provided schema.

Option 1

Option 2

Show child attributes

metadata · object

Optional key-value metadata. Echoed back in webhook deliveries so you can route updates to systems like Slack.

Show child attributes

Response

201

application/json

The created monitor with webhook secret

id · string · required

The unique identifier for the monitor

name · string | null · required

An optional display name

status · enum<string> · required

The status of the monitor. active monitors run on schedule and can be triggered manually. paused monitors can only be triggered manually. disabled monitors are auto-disabled after 10 consecutive authentication failures.

Available options: active, paused, disabled

search · object · required

Show child attributes

trigger · object | null · required

The interval-based schedule for automatic runs. Null if no schedule is set.

Show child attributes

outputSchema · object · required

Controls the format of the run output. Defaults to { "type": "text" } if not specified. When type is "text", the output is a plain text summary. When type is "object", the output is structured JSON. If no properties are specified with "object" type, a schema is inferred automatically; otherwise the output adheres to the provided schema.

Option 1

Option 2

Show child attributes

metadata · object | null · required

Optional key-value metadata for your own tracking. Echoed back in webhook deliveries so you can route updates to systems like Slack.

Show child attributes

webhook · object · required

Show child attributes

nextRunAt · string<date-time> · required

When the next scheduled run will occur. Null if no trigger is set.

createdAt · string<date-time> · required

When the monitor was created

updatedAt · string<date-time> · required

When the monitor was last updated

webhookSecret · string · required

The secret used to verify webhook signatures. This is only returned once at creation time. Store it securely.