> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amps.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> One REST API to read and control batteries, EV chargers, HVAC, solar inverters, and vehicles across manufacturers.

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

<Card title="Quickstart" icon="rocket" href="/quickstart" horizontal>
  Read a sandbox battery and send it a charge command.
</Card>

## How it works

1. **Link.** Your end user connects their device account through [Link UI](/guides/link-ui), a hosted page. You never handle their manufacturer credentials.
2. **Read.** [Pull](/guides/pull) the device's state, for example `GET /battery/{deviceId}`.
3. **Control.** [Push](/guides/push) a command. The API returns `202` and runs it asynchronously.
4. **Confirm.** Get the result from a [webhook](/guides/webhooks) or `GET /actions/{id}`.

## Device types

| Device type | Route | What you can do |
| - | - | - |
| Battery | `/battery` | Read, control, change settings |
| EV charger | `/ev-charger` | Read, control, change settings, list charging sessions |
| HVAC | `/hvac` | Read; control in sandbox |
| Solar inverter | `/solar-inverter` | Read only |
| Vehicle | `/vehicle` | Read only |

What a device accepts depends on its manufacturer. Each device lists the commands and settings it accepts. See [Capabilities](/guides/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](/guides/authentication).

## Next steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Make your first read and command in sandbox.
  </Card>

  <Card title="Authentication" icon="key" href="/guides/authentication">
    Get an API key and pick an environment.
  </Card>

  <Card title="Link UI" icon="link" href="/guides/link-ui">
    Let end users connect their devices.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Every endpoint, request, and response.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.