# Aivi

> Aivi sends iOS Live Activities to the iPhone lock screen, Dynamic Island, Apple Watch, CarPlay, and Mac over a simple HTTP API, and keeps persistent Home Screen and Lock Screen widgets current over the same API. Built for smart home, IoT, and developer workflows.

Key pages:

- [Quick Start](https://docs.getaivi.app/quick-start/): install the app, get an API token, and start a first Live Activity with one HTTP request
- [Home Assistant Live Activities on iPhone](https://docs.getaivi.app/guides/homeassistant/): set up Live Activities from Home Assistant with blueprints, compared with the Companion app
- [Home Assistant iOS widgets](https://docs.getaivi.app/guides/homeassistant-widgets/): Home Screen, Lock Screen, StandBy, and Apple Watch widgets from Home Assistant sensors
- [Home Assistant blueprints](https://docs.getaivi.app/home-assistant/blueprints/): one-click blueprints for every Live Activity template and every display widget template
- [Node-RED and scripts](https://docs.getaivi.app/guides/node-red-and-scripts/): update widgets and Live Activities from Node-RED, cron jobs, or any script
- [openHAB](https://docs.getaivi.app/guides/openhab/): keep a widget or Live Activity in sync with an openHAB item
- [Hosting widget pictures](https://docs.getaivi.app/guides/hosting-pictures/): where to host the pictures for Switchboard tiles
- [Interactive widgets](https://docs.getaivi.app/interactive-widgets/): pressable Switchboard tiles, how a press reaches your system, and how you confirm it
- [API reference](https://docs.getaivi.app/api-reference/): endpoints, authentication, activity states, and errors
- [Limitations](https://docs.getaivi.app/limitations/): the start, update, and reload budgets iOS puts on Live Activities and widgets, and why widget updates can take minutes
- [OpenAPI spec](https://api.getaivi.app/openapi.json): the machine-readable API description

## Documentation Sets

- [Abridged documentation](https://docs.getaivi.app/llms-small.txt): a compact version of the documentation for Aivi, with non-essential content removed
- [Complete documentation](https://docs.getaivi.app/llms-full.txt): the full documentation for Aivi

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [Changelog (latest releases)](https://docs.getaivi.app/changelog/): Most recent Aivi releases and template changes; fetch for the latest version details.