# AyeWatch API

Monitor Internet Information and receive real-time webhook events via the AyeWatch REST API.

Source: https://ayewatch.ai/documentation

Base URL: `https://ayewatch.ai/api/v1`

## What is the AyeWatch API?

The AyeWatch API lets you programmatically manage monitoring internet information topics and
receive real-time notifications when content changes are detected. Instead of manually checking
for updates, you define topics to monitor and AyeWatch delivers structured webhook events to your
application whenever something new happens.

- Create, list, update, and delete monitoring topics via REST
- Receive `topic.update` webhook events with AI-generated summaries
- Verify webhook signatures with HMAC-SHA256
- Authenticate all requests with a Bearer API key

## Quick Start

Get started in two steps: create a topic to monitor, then set up a webhook to receive updates.

### Step 1 — Create a topic (monitors a URL)

Request:

```bash
curl -X POST https://ayewatch.ai/api/v1/topics \
  -H "Authorization: Bearer aw_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "https://openai.com/news",
    "interval": "1_hour"
  }'
```

Response — 201 Created:

```json
{
  "data": {
    "id": 1042,
    "name": "https://openai.com/news",
    "topic_type": "web_page",
    "is_active": true,
    "interval": "1_hour",
    "schedule_arn": "arn:aws:scheduler:...:schedule/default/topic-1042",
    "next_run_at": null,
    "created_at": "2026-08-03T12:00:00Z",
    "schedule_status": "synced"
  }
}
```

### Step 2 — Configure your webhook endpoint

Set your webhook URL in the [Developer dashboard](https://ayewatch.ai/developer/webhook). AyeWatch will POST
events to your endpoint whenever a topic is checked.

Example webhook payload:

```json
{
  "topic_id": 1042,
  "topic_name": "https://openai.com/news",
  "headline": "GPT-5 announced",
  "content": "OpenAI today announced GPT-5...",
  "created_at": "2026-03-08T13:00:00Z"
}
```

## Explore the Docs

- [Authentication](https://ayewatch.ai/documentation/authentication) — API key format, Bearer headers, and security tips.
- [Topics API](https://ayewatch.ai/documentation/topics) — Create, list, update, and delete monitoring topics.
- [Webhooks](https://ayewatch.ai/documentation/webhooks) — Event format, HMAC signature verification, and retry behavior.
- [Errors](https://ayewatch.ai/documentation/errors) — HTTP status codes and standard error response shape.

## Markdown for LLMs and Agents

Every page in these docs is also served as plain markdown. Append `.md` to any documentation URL
(for example `https://ayewatch.ai/documentation/topics.md`), or request the HTML URL with an
`Accept: text/markdown` header. The complete reference in one file is at
`https://ayewatch.ai/documentation/all.md`, and site-wide summaries live at `https://ayewatch.ai/llms.txt`
and `https://ayewatch.ai/llms-full.txt`.
