Update battery device settings

POST

battery

{deviceId}

settings

curl

curl --request POST \
  --url 'https://api.amps.ai/battery/device_abc123/settings' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --data '{
    "safety_reserve": {
      "value": 20,
      "unit": "percent"
    }
  }'

const response = await fetch('https://api.amps.ai/battery/device_abc123/settings', {
  method: 'POST',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
    'content-type': 'application/json',
  },
  body: JSON.stringify({
    "safety_reserve": {
      "value": 20,
      "unit": "percent"
    }
  }),
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/battery/device_abc123/settings'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
    'content-type': 'application/json',
}
payload = {
    "safety_reserve": {
        "value": 20,
        "unit": "percent",
    },
}

response = requests.post(url, headers=headers, json=payload)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/battery/{deviceId}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'safety_reserve' => [
        'value' => 20,
        'unit' => 'percent'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.amps.ai/battery/{deviceId}/settings"

	payload := strings.NewReader("{\n  \"safety_reserve\": {\n    \"value\": 20,\n    \"unit\": \"percent\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.amps.ai/battery/{deviceId}/settings")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"safety_reserve\": {\n    \"value\": 20,\n    \"unit\": \"percent\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amps.ai/battery/{deviceId}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"safety_reserve\": {\n    \"value\": 20,\n    \"unit\": \"percent\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "deviceId": "device_abc123",
    "updated": [
      "safety_reserve"
    ]
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

deviceId

string

required

The unique identifier for the battery device.

Example:

"device_abc123"

Body

application/json

Sparse map of writable settings. At least one field is required. Each value uses the canonical { value, unit } shape; unit must match the canonical setting.

Sparse map of writable settings. At least one field is required. Unknown or read-only keys are rejected with UNSUPPORTED_SETTING.

safety_reserve

Quantity · object

The lowest state-of-charge the battery will ever reach, even during a power cut. (unit: percent, min: 0, max: 100)

Show child attributes

discharge_floor

Quantity · object

The lowest state-of-charge the battery will reach during normal operation. (unit: percent, min: 0, max: 100)

Show child attributes

charge_ceiling

Quantity · object

The highest state-of-charge the battery will charge to. (unit: percent, min: 0, max: 100)

Show child attributes

export_limit

Quantity · object

Maximum power the battery can send back to the grid. (unit: watts, min: 0)

Show child attributes

max_charge_rate

Quantity · object

Maximum rate the battery will charge at. (unit: amps, min: 0, max: 1000)

Show child attributes

max_discharge_rate

Quantity · object

Maximum rate the battery will discharge at. (unit: amps, min: 0, max: 1000)

Show child attributes

Response

Settings written. Response lists the canonical setting keys that changed.

success

boolean

required

Always true for success responses.

data

Battery Settings Update · object

required

Acknowledgement of a settings write. updated lists the canonical setting keys that changed; OEMs that fire-and-forget will still echo the keys. A device holds only the values its own hardware steps to, so a written value can land on the nearest step it can deliver. Read the settings back to see what it holds. A value the device cannot deliver at all is refused rather than quietly adjusted.

Show child attributes

meta

Response Meta · object

required

Metadata attached to every response: the request identifier, the serving environment, the build timestamp, and the server-side latency.

Show child attributes

curl

curl --request POST \
  --url 'https://api.amps.ai/battery/device_abc123/settings' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --data '{
    "safety_reserve": {
      "value": 20,
      "unit": "percent"
    }
  }'

const response = await fetch('https://api.amps.ai/battery/device_abc123/settings', {
  method: 'POST',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
    'content-type': 'application/json',
  },
  body: JSON.stringify({
    "safety_reserve": {
      "value": 20,
      "unit": "percent"
    }
  }),
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/battery/device_abc123/settings'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
    'content-type': 'application/json',
}
payload = {
    "safety_reserve": {
        "value": 20,
        "unit": "percent",
    },
}

response = requests.post(url, headers=headers, json=payload)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/battery/{deviceId}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'safety_reserve' => [
        'value' => 20,
        'unit' => 'percent'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.amps.ai/battery/{deviceId}/settings"

	payload := strings.NewReader("{\n  \"safety_reserve\": {\n    \"value\": 20,\n    \"unit\": \"percent\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.amps.ai/battery/{deviceId}/settings")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"safety_reserve\": {\n    \"value\": 20,\n    \"unit\": \"percent\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amps.ai/battery/{deviceId}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"safety_reserve\": {\n    \"value\": 20,\n    \"unit\": \"percent\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "deviceId": "device_abc123",
    "updated": [
      "safety_reserve"
    ]
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Get Started

Concepts

API Reference

Guides

Quick reference

More

Authorizations

Path Parameters

Body

Response