canonical: https://jentic.com/apis/hologram.io/hologram

# Hologram REST API

The Hologram REST API manages cellular connectivity for IoT fleets, letting you activate SIMs, list and update devices, and control their data and messaging. It exposes operations to pause or unpause data, change plans, set usage limits and thresholds, retrieve device locations and state history, send SMS and cloud messages to devices, and read alerts, data plans, and usage sessions. Requests authenticate with an API key over HTTP Basic authentication.

## For AI agents

Manage a Hologram IoT SIM and device fleet: activate SIMs, pause or resume data, change plans, set usage limits, send messages to devices, and read alerts and usage.

## Scope

Does not provision physical hardware or handle payment processing beyond account balance top-ups. Use for managing Hologram SIMs, devices, alerts, and messaging only.

## Capabilities

- Activate cellular SIMs individually or by ICCID range
- List devices and retrieve device locations and details
- Pause or unpause device or SIM data, individually or in bulk
- Change data plans and set overage, SMS, and data-threshold limits
- Send SMS and cloud messages to a device
- List and acknowledge alerts, and read data plans and usage sessions

## Use cases

### Agent-Managed IoT SIM Fleet

An AI agent operating a fleet of connected devices activates new SIMs, monitors their data usage, and pauses any that exceed a threshold. The Hologram REST API exposes SIM activation, data pause and unpause, and usage-limit operations, so the agent keeps the fleet within budget through Jentic without a developer scripting each call.

Example prompt: Activate a SIM by ICCID and set its data overage limit

### Automated Usage Alerts and Response

When a device crosses a usage threshold, an agent needs to see the alert and act. The Hologram REST API lists usage and custom alerts and lets an agent acknowledge them, so a monitoring agent can triage alerts and pause the affected device's data.

Example prompt: List unacknowledged usage alerts and pause data on the devices that triggered them

### Device Messaging from an Agent

A remote device needs a command or notification pushed to it. The Hologram REST API sends SMS and cloud messages to a device, so an agent can deliver a message or trigger an action on hardware in the field.

Example prompt: Send a cloud message to a device by its device ID

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/1/links/cellular/sim_{ICCID}/claim` | Activate a single SIM by ICCID |
| GET | `/api/1/devices` | List all devices |
| GET | `/api/1/devices/locations` | List all device locations |
| POST | `/api/1/devices/{deviceid}/state` | Pause or unpause device data |
| POST | `/api/1/links/cellular/{linkid}/limit/overage` | Update a SIM's overage limit |
| POST | `/api/1/sms/incoming` | Send an SMS to a device |
| GET | `/api/1/alerts/usage` | List all usage alerts |
| GET | `/api/1/plans` | List all data plans |

## Key resources

- **Devices** — List, retrieve, and update devices, get locations, and pause or resume data
- **Cellular Links** — Activate SIMs and manage plans, limits, thresholds, and state
- **Alerts** — List usage, custom, and TAC-change alerts and acknowledge them
- **Messaging** — Send SMS and cloud messages to devices
- **Organizations** — Retrieve organizations, balances, and balance history

## Why Jentic

- **Setup:** Wiring Hologram by hand means base64-encoding your API key for HTTP Basic authentication, sending it on every call, and mapping 58 device, SIM, and alert endpoints yourself. Through Jentic you install once, import the Hologram REST API from the Directory, store your key once, and your agent calls it.
- **Permission scoping:** Devices and SIMs are addressed by ID in the URL path (`/api/1/devices/{deviceid}`), so a rule can pin your agent to a specific device or link. You choose the operations it may call, so it can pause data or read usage without being able to change plans or add balance.
- **Credential handling:** Your Hologram API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'activate a hologram sim' or 'pause device data', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint.

## Related APIs

- **1NCE API** — 1NCE provides cellular IoT connectivity and SIM management on a flat-rate model, an alternative connectivity provider to Hologram.
- **EMnify API** — EMnify offers global cellular IoT connectivity with SIM and device management, another provider comparable to Hologram.
- **Particle API** — Particle is an IoT device platform for firmware and device cloud data that pairs with a connectivity provider like Hologram.

## FAQ

### What authentication does the Hologram REST API use?

The Hologram REST API authenticates with your API key sent over HTTP Basic authentication, per its OpenAPI spec. Through Jentic the key is stored encrypted by your own Jentic One instance and injected when your agent calls the API.

### Is there a Hologram API MCP server?

You don't need an MCP server to give your agent the Hologram REST API. Jentic connects it directly from the API Directory: import it, store your API key once, and your agent activates SIMs and manages devices as it needs to. Nothing extra is loaded into the agent's context until a call is made.

### Can I limit what my agent is allowed to do with the Hologram REST API?

Yes. You choose which of the 58 operations your agent may call, so you can allow read operations like listing devices and usage while withholding the ones that change plans or add account balance. Every call it makes is logged for review.

### Can I pause a device's data through the Hologram REST API?

Yes. The API has an operation to pause or unpause data on a device by its device ID, plus a bulk version, so an agent can stop data on a device that has exceeded its limit.

### How do I activate a Hologram SIM through Jentic?

Search Jentic for 'activate a hologram sim', which returns the SIM activation operation with its input schema. Add the Hologram REST API from the Jentic API Directory, store your API key once, and your agent can activate SIMs and manage devices. To run it on your own infrastructure, install Jentic One from its GitHub repo.