Introduction
Welcome to Haltless
Haltless is a predictive-maintenance platform for industrial equipment. You stream sensor data from your machines into Haltless, and Haltless watches that data in real time, flags anomalies with AI-powered detection, and turns those signals into alerts and maintenance actions before a failure takes a line down.
Everything you can do in the Haltless dashboard, you can also do through the API. This documentation is written for developers who want to integrate their machines, systems, and tools with Haltless.
All requests go to a single base URL:
https://api.haltless.io/api/v1
What you can build
- Stream machine data in. Push sensor readings continuously from the Edge Agent (OPC-UA, Modbus, CSV, or JSON sources) or send them yourself with a direct
POST /api/v1/ingestcall. - Get anomaly alerts out. Haltless runs incoming readings through anomaly detection and raises alerts when a machine drifts out of its normal operating range. Read those alerts over the API, receive them in real time over a WebSocket, or have them delivered to your own systems via webhooks.
- Automate maintenance. Turn alerts into work orders, log downtime, track OEE, and keep maintenance records in sync with the systems your team already uses.
How the docs are organized
| Section | What you'll find |
|---|---|
| Getting Started | The fastest path from zero to your first alert: quickstart, how it works, and authentication. |
| Edge Agent | Install and configure the agent that collects data from your machines: overview, installation, configuration, protocols, and troubleshooting. |
| Guides | Task-focused walkthroughs: managing API keys, direct ingestion, webhook setup, and WebSocket integration. |
| API Reference | Endpoint-by-endpoint details for every resource, from machines and sensor data to alerts, predictions, and more. |
Start here
New to Haltless? The fastest way to see it work is the quickstart, which takes you from an API key to your first alert with a few curl commands.
If you just want to understand the moving parts first, read How Haltless works, then come back to the Quickstart.
- Quickstart — send your first reading and receive your first alert.
- How Haltless works — the path your data takes, end to end.
- Authentication — how to obtain and use access tokens and API keys.