Alpha Notice: The Monitor API is currently in public alpha. Endpoints and
request/response formats are subject to change.
Features and Use Cases
The Monitor API can be used to automate continuous research for any topic, including companies, products, or regulatory areas— without building complicated web monitoring infrastructure. Define a query once along with the desired schedule, and the service will detect relevant changes and deliver concise updates (with source links) to your systems via webhooks.- News tracking: Alert when there’s notable news about a company or product you’re interested in
- Competitive monitoring: Detect when competitors launch new features or pricing changes
- Regulatory updates: Track new rules or guidance impacting your industry
- Deal/research watchlists: Surface events about entities you care about
- Tracking products: Track modifications to a product listing
- Scheduling: Set update cadence to Hourly, Daily, or Weekly
- Webhooks: Receive updates when events are detected or when monitors finish a scheduled run
- Events history: Retrieve updates from recent runs or via a lookback window (e.g.,
10d) - Lifecycle management: Update cadence, webhook, or metadata; delete to stop future runs
Getting Started
Prerequisites
Generate your API key on Platform, then set it in your shell:Step 1. Create a monitor
Create a monitor that gathers daily AI news: Request:Step 2. Detecting and retrieving events via webhooks
When a change is detected, your webhook receives:- Use
data.event.event_group_idwith the GET endpoint in Step 2 to fetch the full events. data.monitor_idtells you which monitor fired.data.metadataechoes what you set at creation, so you can route the webhook (e.g., to a Slack thread or ticket).
event_group_id (for a detected change),
fetch the full set of related events for that group:
Request:
Lifecycle
The Monitor API follows a straightforward lifecycle:- Create: Define your
query,cadence, and optionalwebhookandmetadata. - Update: Change cadence, webhook, or metadata.
- Delete: Delete a monitor and stop future executions.
See Pricing for a detailed scheduled of rates.
Best Practices
- Scope your query: Clear queries with explicit instructions lead to higher-quality event detection.
- Choose the right cadence: Use
hourlyfor fast-moving topics,dailyfor most news,weeklyfor slower changes. - Use webhooks: Prefer webhooks to avoid unnecessary polling and reduce latency to updates.
- Manage lifecycle: Cancel monitors you no longer need to reduce your usage bills.
Next Steps
- Events: Understand events, when they are emitted and how to access them.
- Webhooks: Information on setting up webhooks and listening for push notifications.
- API Reference: Complete endpoint documentation