| Term | Description | Reference |
|---|---|---|
| Action | The record created when you push a command. It has an id you can track. | Push |
| Action state | Where an action is in its lifecycle: scheduled, acknowledged, completed, failed, or cancelled. | Push |
auto.* commands | Commands that hand control to the device’s own logic, such as auto.balance for a battery or auto.schedule for a thermostat. | Push |
| Capabilities | The commands, settings, and conflictStrategies a device declares on its read. Build requests from these. | Capabilities |
| Capability refusal | 422 DEVICE_NOT_CAPABLE when a device doesn’t offer what you asked for, or 503 CAPABILITY_PAUSED when Amps has paused it. | Capabilities |
| Charging session | One charge of a vehicle on an EV charger, listed with GET /ev-charger/{deviceId}/sessions. | Session history |
| Command | What you ask a device to do, such as charge, idle, or heat. | Push |
| Conflict strategy | The onConflict value that decides what happens when a device already has a pending action: cancel_and_replace or queue_after. | Conflicts |
| Consent revocation | Removing your access to an end user’s devices with DELETE /users/{userId}/consent. | Link UI |
| Envelope | The { success, data | error, meta } wrapper on every response. | Error handling |
| Execution | When a command can run: immediate, scheduled, or windowed. Listed per command on the device read. | Scheduling |
| Expedite | ?expedite=true on a read, for fresher state from the manufacturer. | Pull |
externalUserRef | Your identifier for an end user, passed to Link UI. The same value is the userId filter on device lists and consent revocation. | Link UI |
| Link UI | The hosted page where end users connect their manufacturer accounts. | Link UI |
| Live | The environment for real devices. Reached with an sk_live_ key. | Authentication |
| Plant-local time | Wall-clock time at the device’s location, with no UTC offset. Used for start and end. | Scheduling |
| Quantity | A { value, unit } pair used for every command parameter and setting. | Push |
| Read-only device | Solar inverters and vehicles. You can read them but not send them commands. | Capabilities |
| Sandbox | The environment for simulated devices. Reached with an sk_test_ key. Simulated state reflects the commands you send. | Authentication |
| Setting | A standing configuration value on a device, such as a charge rate limit. Changed with a settings write. | Settings |
| Webhook | An HTTP request Amps sends you when an action finishes or a device’s connection changes. | Webhooks |
| Window | An action with an end. It runs from start (or now) until end. | Scheduling |
Get started
Glossary
Amps API terms and where each one is explained.