EXexa
Monitors

Create a monitor

Changed on

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.

post/monitors

Request

  • Base URL
    https://api.exa.ai
  • URL
    https://api.exa.ai/monitors
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Request body

namestring

An optional name for the monitor

metadataobject

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

Response

The created monitor with webhook secret

idstring required

The unique identifier for the monitor

namestring nullable required

An optional display name

status'active' | 'paused' | 'disabled' 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.

metadataobject nullable required

Caller-provided key-value metadata for your own tracking.

nextRunAtstring date-time nullable required

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

createdAtstring date-time required

When the monitor was created

updatedAtstring date-time required

When the monitor was last updated

webhookSecretstring required

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

Changes

  • 69325a6257a1Revision changes
    • info

      request property // deprecated

    • info

      response property search/contents/livecrawl deprecated

  • bdc8cb31dce4Revision changes
    • info

      request property //// deprecated

    • info

      request property //// deprecated

    • info

      request property /////// deprecated

    • info

      response property search/contents/extras/codeBlocks/anyOf[subschema #1]/ deprecated

    • info

      response property search/contents/extras/richLinks/anyOf[subschema #1]/ deprecated

    • info

      response property search/contents/summary/oneOf[SummaryWithMaxTokensOptionsOutput]/maxTokens deprecated