API Reference Overview
The Hestia Labs Cloud API is the Digital Bridge between your applications and your smart world. It allows you to securely manage your devices, organize your environments, and send intelligent commands with total confidence.
How to Use This Reference
Whether you are building a custom dashboard, a mobile app, or a simple automation script, this reference provides the map for how to talk to our cloud.
- Identity & Access: How to prove who you are and manage your security keys.
- Managing Devices: How to add new hardware and check its current status.
- Sending Commands: How to tell your world what to do (e.g., "Lock the front door").
- Organizing Your Space: How to group your devices into homes and rooms.
The Base Address
All communication with the Hestia Labs cloud starts at this address:
https://api.hestialabs.in/api/v1
Security & Authentication
To ensure that only you can control your world, every request must include a Security Token. This token acts like a temporary key that proves your identity.
Authorization: Bearer <your_security_token>
You can get your tokens through our Management Console or by logging in via our command-line tool.
Understanding the Responses
When you talk to our API, the cloud will respond with a status code. Think of these as a quick "thumbs up" or "thumbs down" on your request.
| Code | Status | What it Means |
|---|---|---|
| 200 | OK | Everything worked perfectly. |
| 201 | Created | You successfully added something new (like a device). |
| 400 | Bad Request | Something was wrong with your message. |
| 401 | Unauthorized | Your security token is missing or incorrect. |
| 403 | Forbidden | You don't have permission to do this specific action. |
| 429 | Rate Limited | You're sending requests too fast—please slow down. |
| 500 | Internal Error | Something went wrong on our end. |
Prefer an SDK?
Building directly against an API can be complex. We recommend using our Smart Connect Libraries (SDKs) which handle the security and communication for you:
// For Web & Mobile developers
import { HxTPAdminClient } from "hxtp-js";
// For Data & Automation developers
from hxtp.client import SyncHxTPClient
For a complete list of every single endpoint available, see the Full API Index.