Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Exa Monitors API

The Monitors API from Exa — 6 operation(s) for monitors.

Exa Monitors API is one of 19 APIs that Exa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Monitors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 12 operations across 6 paths, and defines 32 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.exa.ai.

12 operations 6 paths 32 schemas 2 DELETE4 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.exa.ai
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Exa Monitors API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (apiKey). It accepts HTTP bearer tokens (bearer). By default, every request must be authenticated.

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

Paths & Operations 12

Across 6 paths, the API surfaces 12 operations — 2 DELETE, 4 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Monitors 12
POST
/monitors
Create a Monitor
createMonitor body → 201
GET
/monitors
List Monitors
listMonitors 5 params → 200
POST
/monitors/batch
Batch Action on Monitors
batchMonitors body → 200
GET
/monitors/{id}
Get a Monitor
getMonitor 1 param → 200
PATCH
/monitors/{id}
Update a Monitor
updateMonitor 1 param body → 200
DELETE
/monitors/{id}
Delete a Monitor
deleteMonitor 1 param → 200
POST
/monitors/{id}/trigger
Trigger a Monitor
triggerMonitor 1 param → 200
POST
/v0/monitors
Create a Monitor
monitors-create body → 201
GET
/v0/monitors
List Monitors
monitors-list 3 params → 200
GET
/v0/monitors/{id}
Get Monitor
monitors-get 1 param → 200
PATCH
/v0/monitors/{id}
Update Monitor
monitors-update 1 param body → 200
DELETE
/v0/monitors/{id}
Delete Monitor
monitors-delete 1 param → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are CreateSearchMonitorResponse (12 properties), Monitor (11 properties), MonitorRun (11 properties), SearchMonitorContents (11 properties). Each schema is shown below with its type and property counts.

CustomEntity
object
2 properties 2 required
Monitor
object
11 properties 11 required
SearchMonitorContents
object
Content extraction options applied to each search result. All fields are optional.
11 properties
PersonEntity
object
1 property 1 required
CreateSearchMonitorResponse
object
12 properties 12 required
SearchMonitorOutputSchemaOutput
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 "…
MonitorCadence
object
2 properties 1 required
SearchMonitorTriggerOutput
object
2 properties 2 required
BatchMonitorsResponse
object
5 properties 5 required
SearchMonitorWebhookOutput
object
2 properties 1 required
Entity
SearchMonitorWebhook
object
2 properties 1 required
ArticleEntity
object
1 property 1 required
CompanyEntity
object
1 property 1 required
BatchMonitorsRequest
object
4 properties 2 required
UpdateSearchMonitorParameters
object
7 properties
MonitorRun
object
11 properties 11 required
ResearchPaperEntity
object
1 property 1 required
CreateSearchMonitorParameters
object
6 properties 2 required
CreateMonitorParameters
object
4 properties 3 required
ListSearchMonitorsResponse
object
3 properties 2 required
SearchMonitorSearchOutput
object
3 properties 1 required
SearchMonitorContentsOutput
object
Content extraction options applied to each search result. All fields are optional.
11 properties
MonitorBehavior
object
2 properties 2 required
SearchMonitor
object
11 properties 11 required
UpdateMonitor
object
4 properties
ListMonitorsResponse
object
3 properties 3 required
SearchMonitorSearch
object
3 properties 1 required
SearchMonitorTrigger
object
2 properties 2 required
SearchMonitorOutputSchema
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 "…
TriggerSearchMonitorResponse
object
1 property 1 required
JsonValue
Any JSON value.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exa-ai-monitors-api-openapi.yml Raw ↑

Other APIs Exa publishes across the network.

Exa Agent API
Exa Answer API
Exa Contents API
Exa Enrichments API
Exa Events API
Exa Imports API
Exa Items API
Exa Monitors Runs API
Exa Research API
Exa Runs API
Exa Search API
Exa Searches API