Index of every page on this site: llms.txt
All skills
exa-labs avatar

/build-with-exa

@9d220cc
by Exa Labsexa-labs/agent-skills75 stars
8
Run it yourself

Build applications and agents with Exa's API: search, contents extraction, answer, Agent API, monitors, websets, OpenAI-compatible endpoints, and exa-py/exa-js SDKs. Use when choosing Exa endpoints, writing Exa API calls, integrating semantic web search or research into products, or debugging Exa request shapes.

Use this Skill: https://skilld.dev/gh/exa-labs/agent-skills/build-with-exa

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencesmonitors.md

≈1k tokens on demand. Your agent reads this file only when SKILL.md points to it.

Monitors API Reference

Standalone recurring-search surface via https://api.exa.ai/monitors.

Canonical Docs Links

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

Contents

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

Overview

The Monitors API runs Exa searches on a schedule and delivers results to a webhook. Use it for recurring monitoring workflows such as:

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

This file covers the standalone Monitors API only. Websets has its own monitor subresources inside the Websets API family; see migrate-websets-to-agent.md for moving those workloads here.

Endpoint Summary

Method Path Purpose
POST /monitors Create a monitor
GET /monitors List monitors
GET /monitors/{id} Get one monitor
PATCH /monitors/{id} Update a monitor
DELETE /monitors/{id} Delete a monitor
POST /monitors/{id}/trigger Trigger an on-demand run
GET /monitors/{id}/runs List runs
GET /monitors/{id}/runs/{runId} Get one run

Create Shape

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

Create Fields

Field Type Notes
name string Optional display name
search object Required search payload
trigger object Optional interval schedule; omit for manual-only monitors
outputSchema object Optional structured output
metadata object Optional caller metadata
webhook object Required webhook configuration

Search Payload and Trigger Shape

  • query
  • optional numResults
  • optional nested contents

For recurring behavior, the key extra concept is trigger:

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

trigger can be removed on update by setting it to null.

Runs, Statuses, and Updates

Monitor statuses in current Exa docs:

  • 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

Update semantics:

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

Webhook Handling

Creating a monitor returns a one-time webhookSecret. Store it immediately. It is required for verifying webhook signatures and cannot be fetched later.

This is one of the most important operational details in the Monitors API.

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"
    },
    "trigger": {
        "type": "interval",
        "period": "1d"
    },
    "webhook": {
        "url": "https://example.com/webhook"
    }
})

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

Current Exa Python monitor examples use an API-shaped params dict, so the nested search payload commonly stays in camelCase even though the core Python search helpers are snake_case.

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.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2d3 checks · Risk SAFE
  • Gen Agent Trust Hub3d

    The skill provides official documentation and SDK guidance for the Exa API. It includes instructions for installing and using official Python and TypeScript libraries and provides best practices for semantic search and AI research workflows.

  • Socket2d

    No alerts

  • Snyk3d

    Risk: MEDIUM · 1 issue

Signed by skilld at 9d220cc. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 4 days ago.

Activeupdated 5 days ago
metadata
{
  "author": "Exa",
  "version": "0.3.0",
  "docs": "https://exa.ai/docs"
}

README badge

README badge for exa-labs/agent-skills/build-with-exa