Messages

{
  "request_id": "a1b2c3d4-0000-0000-0000-000000000001",
  "actor_uid": "actor_a1b2c3",
  "asset_id": 123456,
  "connector_id": 1,
  "action": "SET_EVSE_INPUT_LIMIT",
  "limit": 16,
  "unit": "A",
  "valid_to": "2026-10-31T09:00:00.000Z",
  "distribution_strategy": "DISTRIBUTE",
  "metadata": {
    "reason": "Low solar power output"
  }
}

{
  "request_id": "a1b2c3d4-0000-0000-0000-000000000001",
  "actor_uid": "actor_a1b2c3",
  "asset_id": 123456,
  "connector_id": 1,
  "action": "CLEAR_EVSE_INPUT_LIMIT",
  "metadata": {
    "reason": "The power limit is no longer needed"
  }
}

{
  "request_id": "a1b2c3d4-0000-0000-0000-000000000001",
  "actor_uid": "actor_a1b2c3",
  "asset_id": 42,
  "action": "SET_CIRCUIT_FUSE_LIMIT",
  "limit": 200,
  "valid_to": "2026-10-31T09:00:00.000Z",
  "fallback_limit": {
    "limit": 100,
    "apply_after": 300
  },
  "metadata": {
    "reason": "Location booster battery at 10%"
  }
}

{
  "request_id": "a1b2c3d4-0000-0000-0000-000000000001",
  "actor_uid": "actor_a1b2c3",
  "asset_id": 42,
  "action": "CLEAR_CIRCUIT_FUSE_LIMIT",
  "metadata": {
    "reason": "Location booster battery at 75%"
  }
}

Control Request

Single endpoint accepting all control command types. Since processing is asynchronous, the HTTP response only reflects whether the request was accepted for processing (authenticated, well-formed) — the actual outcome of applying the request is delivered later as a controlResponse message correlated by request_id.

Rate limiting

Limited to 1 request every 5 seconds, tracked independently for each connector and action — i.e. SET_EVSE_INPUT_LIMIT is tracked separately from CLEAR_EVSE_INPUT_LIMIT and individually per asset. Exceeding it produces a controlResponse with result: TOO_MANY_REQUESTS.

WSS

control-request

Messages

{
  "request_id": "a1b2c3d4-0000-0000-0000-000000000001",
  "actor_uid": "actor_a1b2c3",
  "asset_id": 123456,
  "connector_id": 1,
  "action": "SET_EVSE_INPUT_LIMIT",
  "limit": 16,
  "unit": "A",
  "valid_to": "2026-10-31T09:00:00.000Z",
  "distribution_strategy": "DISTRIBUTE",
  "metadata": {
    "reason": "Low solar power output"
  }
}

{
  "request_id": "a1b2c3d4-0000-0000-0000-000000000001",
  "actor_uid": "actor_a1b2c3",
  "asset_id": 123456,
  "connector_id": 1,
  "action": "CLEAR_EVSE_INPUT_LIMIT",
  "metadata": {
    "reason": "The power limit is no longer needed"
  }
}

{
  "request_id": "a1b2c3d4-0000-0000-0000-000000000001",
  "actor_uid": "actor_a1b2c3",
  "asset_id": 42,
  "action": "SET_CIRCUIT_FUSE_LIMIT",
  "limit": 200,
  "valid_to": "2026-10-31T09:00:00.000Z",
  "fallback_limit": {
    "limit": 100,
    "apply_after": 300
  },
  "metadata": {
    "reason": "Location booster battery at 10%"
  }
}

{
  "request_id": "a1b2c3d4-0000-0000-0000-000000000001",
  "actor_uid": "actor_a1b2c3",
  "asset_id": 42,
  "action": "CLEAR_CIRCUIT_FUSE_LIMIT",
  "metadata": {
    "reason": "Location booster battery at 75%"
  }
}

x-api-key

type:httpApiKey

API key issued to the Actor during registration. Spirii can revoke and reissue keys at any time.

Set EVSE Input Limit

type:object

Set the maximum input current/power an EVSE may draw from the grid.

Clear EVSE Input Limit

type:object

Remove a previously set EVSE input limit.

Set Circuit Fuse Limit

type:object

Temporarily override a circuit's fuse capacity.

Clear Circuit Fuse Limit

type:object

Remove a previously set circuit fuse limit override.

Get started

Spirii API

EMSP API

Billing API

Energy Management API

Legacy API

Control Request

Rate limiting