# NoticeFox API docs

NoticeFox delivers rich, animated notifications to your iPhone, Apple Watch and Vision Pro.
Scripts, Home Assistant, CI jobs and AI agents send them with one HTTP request.

These docs are plain Markdown. Every page is available as `.md`, and
[`llms.txt`](llms.txt) and [`llms-full.txt`](llms-full.txt) give agents the same content in
the [llms.txt](https://llmstxt.org) format.

## Pages

- [Getting started](getting-started.md): get a send token and send your first notification.
- [curl examples](curl.md): the JSON endpoint and the key-in-URL simple endpoint.
- [Fields and limits](fields.md): every send field, its limits, aliases, precedence and
  conflicts, levels and Pushover priorities, and the scene catalog.
- [Home Assistant](home-assistant.md): a REST notifier and a `rest_command`.
- [Apprise](apprise.md): sending through Apprise's `json://` plugin.
- [Error codes](errors.md): every error code, its status, and what to do.
- [Quotas and rate limits](quotas.md): monthly sends, bursts and other limits.
- [Security and redaction](security.md): credentials, what is logged, and how to keep a
  token safe.
- [Authorization](authorization.md): what each credential may do.

The API contract itself is the OpenAPI 3.1 document `backend/openapi.yaml` in the
repository.

## Base URL

Examples use `$NOTICEFOX_URL` (in shell) or `https://api.noticefox.app` (in configuration
files) for the service's base URL: the URL of the service your token belongs to, with no
trailing slash, which is `https://api.noticefox.app` unless you use a test service. A token works only with the service that issued it.