---
title: WatchFor Developers — REST API, MCP server, SDKs & OpenAPI
description: Every WatchFor developer resource on one page: REST API reference, OpenAPI 3.1 specification, authentication, MCP server, A2A agent, sandbox, SDKs and CLI for TypeScript, Python and Ruby.
canonical: https://watchfor.io/developers
---

Developers

# WatchFor for developers and AI agents

Everything in the WatchFor dashboard is available to code: a REST API described by an OpenAPI 3.1 specification, an MCP server, an A2A agent, SDKs and a CLI in three languages, and a sandbox you can call before you create a key. Same permissions, same data, no separate product.

[Read the API reference](/docs/api)[Get an API key (free plan)](/auth/sign-up)

## Quick start

# Create a key in Settings -> API keys, then:
curl https://watchfor.io/api/v1/summary \
-H "Authorization: Bearer wf_live_..."

# No key yet? The sandbox answers with real shapes:
curl https://watchfor.io/api/v1/sandbox/summary Base URL https://watchfor.io/api/v1 , Bearer API keys or OAuth 2.1, JSON in and out, cursor pagination on every list. The full walkthrough is in the [WatchFor REST API reference](/docs/api).

## REST API

- [WatchFor REST API referenceMonitors, checks, alert rules, incidents, maintenance windows, status pages, reports and the audit trail over JSON, with curl examples.](/docs/api)
- [OpenAPI 3.1 specificationThe machine-readable document behind the API: stable operationIds, typed schemas, scopes, and how to generate a client. Raw file at /openapi.json.](/docs/api/openapi)
- [AuthenticationAPI keys with read or write scope, and OAuth 2.1 with dynamic client registration and PKCE for agents that should never see a key.](/docs/api/authentication)
- [Errors & rate limitsThe error envelope, every status code you can receive, per-plan rate limits and the headers that tell you where you stand.](/docs/api/errors)
- [Operations & reliabilityVersioning, the 90-day deprecation policy, idempotency, pagination and the API status page.](/docs/api/operations)
- [Monitor types referenceConfig keys and alert metrics for all 25 monitor types, also served live at /api/v1/meta/monitor-types.](/docs/api/monitor-types)

## AI agents

- [MCP server45 tools over the same API for Claude, Cursor, VS Code and any MCP client, plus reference resources and prompt templates. Streamable HTTP at /api/mcp.](/docs/api/mcp)
- [A2A agentAgent2Agent JSON-RPC endpoint for agents that delegate tasks: diagnose incidents, check status, act. Agent Card at /.well-known/agent-card.json.](/docs/api/a2a)
- [Live diagnostics22 checks an agent runs on demand from the probe fleet — DNS, propagation, TLS, HTTP, redirects, WebSocket, SMTP, NTP, ping, ports and more — against any public target, monitored or not. One call diagnoses a target from 3 regions.](/docs/api/diagnostics)
- [Agent quickstart (agents.md)When to use WatchFor, how to authenticate without a human, and which surface to pick. Written for agents, readable by people.](/agents.md)
- [llms.txtA compact description of the whole product for language models, with every machine endpoint listed.](/llms.txt)

## Try it and integrate

- [Sandbox (no auth)Live, read-only sample data in the exact production shapes at /api/v1/sandbox. Exercise the API before creating a key.](/docs/api/sandbox)
- [WebhooksSigned JSON payloads for incident and monitor events, with retries and a delivery log.](/docs/notifications/webhooks)
- [Public status pages & badgesStatus pages on your own subdomain, an embeddable SVG badge and a CORS-enabled status.json.](/docs/status-pages)
- [Monitoring IP ranges & bot identityAllowlist our probes by IP, reverse DNS or RFC 9421 signature; machine-readable list at /ips.json.](/bot)

## SDKs and CLI

One package name on every registry. Each SDK is generated from the OpenAPI specification and ships a small CLI for a quick look from the terminal.

- TypeScript / JavaScript npm install watchfor npx watchfor summary [watchfor on npm](https://www.npmjs.com/package/watchfor)
- Python pip install watchfor watchfor summary [watchfor on PyPI](https://pypi.org/project/watchfor/)
- Ruby gem install watchfor watchfor summary [watchfor on RubyGems](https://rubygems.org/gems/watchfor)

Source, agent skills and an Agent Plugins manifest live on GitHub at [github.com/watchfor-io](https://github.com/watchfor-io).

## Machine-discoverable endpoints

Scanners and agents that discover services by convention find WatchFor at the standard paths: /.well-known/openapi.json , /.well-known/mcp.json , /.well-known/agent-card.json , /.well-known/oauth-authorization-server and /.well-known/ard.json . Agent-readiness is verified independently: 100/100 on is-agentic.com and an A+ on ora.ai.

---

Canonical page: https://watchfor.io/developers · Site guide: https://watchfor.io/llms.txt