Skip to main content

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.

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, because the manifest layer absorbs the differences. Every page in this section is generated from the OpenAPI spec, so the request and response shapes you see 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 mock connectors; a live key reaches real devices. See Authentication and Environments for the full picture. 
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.

Battery

State, actions, settings, and action history for home batteries.

EV charger

State and charge-control actions for EV chargers.

HVAC

State and setpoint actions for heating and cooling.

Solar inverter

Read-only generation and state for solar inverters.

Vehicle

Read-only state for connected vehicles.

Schedules

Coordinate actions over time. Coming soon.

​
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 for the shape and the full code list, and What to expect for the asynchronous action lifecycle that sits behind every push.