​

Monitors API Reference

​

Canonical Docs Links

• Base docs URL: https://exa.ai/docs
• Monitors guide: /reference/monitors-api-guide
• Monitors coding-agent reference: /reference/monitors-api-guide-for-coding-agents

​

Contents

• Overview
• Endpoint summary
• Create shape
• Search payload and trigger shape
• Runs, statuses, and updates
• Webhook handling
• Critical pitfalls

​

Overview

• competitor announcements
• funding events
• policy or regulatory changes
• new publications on a topic

​

Endpoint Summary

​

Create Shape

POST https://api.exa.ai/monitors
{
  "name": "AI Funding Tracker",
  "search": {
    "query": "AI startups that raised Series A funding",
    "numResults": 10
  },
  "trigger": {
    "type": "interval",
    "period": "1d"
  },
  "webhook": {
    "url": "https://example.com/webhook"
  }
}

​

Create Fields

​

Search Payload and Trigger Shape

• query
• optional numResults
• optional nested contents

{
  "trigger": {
    "type": "interval",
    "period": "7d"
  }
}

​

Runs, Statuses, and Updates

• active: runs on schedule and accepts manual triggers
• paused: does not run on schedule but still accepts manual triggers
• disabled: system-disabled, not manually chosen in normal create flows

• all update fields are optional
• search supports partial updates
• manual testing is done through POST /monitors/{id}/trigger

​

Webhook Handling

​

Python Example

from exa_py import Exa

exa = Exa(api_key="YOUR_EXA_API_KEY")
monitor = exa.monitors.create(params={
    "name": "AI Funding Tracker",
    "search": {
        "query": "AI startups that raised Series A funding",
        "numResults": 10
    },
    "trigger": {
        "type": "interval",
        "period": "1d"
    },
    "webhook": {
        "url": "https://example.com/webhook"
    }
})

print(monitor.id)
print(monitor.webhook_secret)

​

Critical Pitfalls

1. Use search, not searchParams.
2. Use trigger, not a top-level schedule string.
3. Store webhookSecret immediately on create.
4. Keep this Monitors API separate from Websets-owned monitor subresources.
5. Manual triggers still work for paused monitors, but not for system-disabled ones.