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

# API Reference

> Base URL, authentication, and response format for the Amps REST API.

Endpoints are grouped by device type. Each type has a list route and a read route. Battery, EV charger, and HVAC add a push route. Battery and EV charger add a settings route, and EV chargers list charging sessions.

## Base URL

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

Sandbox and live share this host. Your API key selects the environment.

## Authentication

Send your API key in the `x-api-key` header. See [Authentication](/guides/authentication).

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

## Responses

Successful responses wrap the result in `data`. Errors return `error.code`, `error.message`, and optional `error.details`. See [Error handling](/guides/error-handling).

```json theme={null}
{
  "success": true,
  "data": { "id": "device_abc123" },
  "meta": { "requestId": "req_8a2Bf3kP", "timestamp": "2026-06-01T10:30:00.000Z", "environment": "sandbox" }
}
```

## Next steps

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

  <Card title="Error codes" icon="list" href="/guides/error-handling/error-codes">
    Every code, its status, and what triggers it.
  </Card>
</CardGroup>


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