> ## 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

> The Amps REST API: one contract across batteries, EV chargers, HVAC, solar inverters, and vehicles. Base URL, authentication, how the reference is organised, and the response envelope.

The Amps API is one REST contract over every energy device we support: batteries, EV chargers, HVAC systems, solar inverters, and vehicles. You read device state and push canonical actions the same way regardless of the underlying OEM. The request and response shapes on every page in this section are exactly what the API serves.

## Base URL

All requests go to a single host. The environment is selected by your API key, not the URL.

```
https://api.amps.ai
```

## Authentication

Every request carries your API key in the `x-api-key` header. A sandbox key routes to simulated devices; a live key reaches real devices. See [Authentication](/get-started/authentication) and [Environments](/get-started/environments) for the full picture.

```bash theme={null}
curl https://api.amps.ai/battery/dev_abc123 \
  -H "x-api-key: sk_live_abc123xyz"
```

## How the reference is organised

Endpoints are grouped by device type. Each type follows the same pattern: list the devices, read one device's state and capabilities, and, where the device supports control, push an action or update a setting.

<CardGroup cols={2}>
  <Card title="Battery" icon="battery-full" href="/api-reference/battery/get-battery-state">
    State, actions, settings, and action history for home batteries.
  </Card>

  <Card title="EV charger" icon="plug" href="/api-reference/ev-charger/get-ev-charger-state">
    State and charge-control actions for EV chargers.
  </Card>

  <Card title="HVAC" icon="temperature-half" href="/api-reference/hvac/get-hvac-state">
    State and setpoint actions for heating and cooling.
  </Card>

  <Card title="Solar inverter" icon="solar-panel" href="/api-reference/solar-inverter/get-solar-inverter-state">
    Read-only generation and state for solar inverters.
  </Card>

  <Card title="Vehicle" icon="car" href="/api-reference/vehicle/get-vehicle-state">
    Read-only state for connected vehicles.
  </Card>

  <Card title="Schedules" icon="calendar" href="/concepts/scheduling">
    Coordinate actions over time. The resource is coming soon; see the concept page for the shape and what works today.
  </Card>
</CardGroup>

## Responses

A successful call returns the resource as JSON. A failure returns the canonical error envelope: a stable `code`, a human-readable `message`, and optional `details`. See [Error envelope](/concepts/error-envelope) for the shape and the full code list, and [What to expect](/concepts/what-to-expect) for the asynchronous action lifecycle that sits behind every push.