Skip to main content
Amps is a REST API for home energy devices. You read state and send commands the same way whichever manufacturer built the device.

Quickstart

Read a sandbox battery and send it a charge command.

​
How it works

  1. Link. Your end user connects their device account through Link UI, a hosted page. You never handle their manufacturer credentials.
  2. Read. Pull the device’s state, for example GET /battery/{deviceId}.
  3. Control. Push a command. The API returns 202 and runs it asynchronously.
  4. Confirm. Get the result from a webhook or GET /actions/{id}.

​
Device types

What a device accepts depends on its manufacturer. Each device lists the commands and settings it accepts. See Capabilities.

​
Sandbox and live

Both use https://api.amps.ai. Your API key decides which one you reach: sk_test_ for simulated sandbox devices, sk_live_ for real ones. See Authentication.

​
Next steps

Quickstart

Make your first read and command in sandbox.

Authentication

Get an API key and pick an environment.

Link UI

Let end users connect their devices.

API Reference

Every endpoint, request, and response.