REST API Reference

Direct HTTP API access for the webwhen platform.

Naming during the transition

The API host is api.webwhen.ai (api.torale.ai still 301-redirects for legacy clients). Watches are addressed as tasks in URLs (/api/v1/tasks) — the resource rename is a later phase. Endpoint paths below reflect the current shipping API.

Getting started

API Overview — base URLs, authentication methods, and the full endpoint listing.

Authentication — API keys, Clerk JWT, and user-management endpoints.

Endpoints

Watches API — create, list, update, delete, fork, and execute watches.

Executions API — execution history, results, and per-watch trigger feed.

Notifications API — notification send history and delivery tracking.

Reference

Error responses — HTTP status codes, error formats, and common mistakes.

Interactive documentation

webwhen ships interactive API documentation at:

• ReDoc: https://api.webwhen.ai/redoc
• OpenAPI JSON: https://api.webwhen.ai/openapi.json

Note: admin endpoints are intentionally hidden from the OpenAPI schema.

Start with the API Overview to understand authentication and endpoints.