API
API Documentation.Step-by-Step
Learn AlphieInstall & Configure
Controller Runners Separate PostgreSQL DB serverWelcome to the Alphie Documentation
This section walks you through everything in the Alphie controller UI — what each screen does, how to use it, and how it ties into actual automation.
API Documentation
Alphie exposes a REST API for pipelines, jobs, approvals, inventory, and more. If you want to trigger automations from another system (ServiceNow, ticketing, portal buttons, etc.) you’ll be living there.
The API docs include live examples with request and response JSON. You can open them directly using the “API Documentation With Examples” link in the sidebar.
Step By Step ( Learn Alphie )
Step-by-step instructions for using Alphie and creating content, with screenshots.
Install & Configure
Alphie is designed to run in real environments, The install guides cover:
- Controller — Core API / UI service. This is the brain.
- Runners — Remote execution nodes that do the work near your targets (Windows, Linux, network, etc.).
- PostgreSQL — Optionally run your DB on a dedicated box ( Recommended), Or locally for performance and isolation.
Each install doc includes examples on the answers to questions asked during the install scripts runs, and screenshots of what “good” looks like.
Who this is for
This documentation is written for:
- Automation engineers who maintain pipelines and runners
- Platform / infra engineers who deploy Alphie in prod
- Service owners who just want a safe button that does the work every time
If you're the person who gets called at 2AM, this UI is built for you.