Post Pv Control Schedule

Submit steering schedules by providing a start and end time with a 1 min granularity of when you would like pv production/grid export curtailment to be off or 0 % grid export curtailment. When you provide new scheduled controls for the same device that already had an existing control, then we will overwrite any commands scheduled for the pv with the newly provided schedules. If an active curtailment is already active(= off or 0 %) and your newly submitted schedule overlaps with the active one, then we will keep the active curtailment going until your end time has been reached or the start time has been reached and the control-type is different than the active one. start_time should be before end_time and end_time should be in the future. If not, the schedule will be rejected. You can provide a batch of different device_id’s, each with custom or equal schedules. You can provide multiple schedules for the same device_id but keep in mind that the next time you update the schedule for that device_id, you will overwrite all the schedules for that device_id with the new ones you provide. There is a limit (250) to the number of updated device_id schedules you can provide in a batch. If you have many devices, you can split them into multiple batches. Make sure to not send schedules that are from users that have their external steering optimization disabled or are not yet compatible with our system. We will filter these devices out of them regardless. But it is best practice to only send us schedules for users that want to be curtailed and are compatible.

Timestamp fields in UTC.

Time format examples:

• 2023-10-01T00:00:00Z

• 2023-10-01T00:00:00

control_type can be set to export_curtailment, production_curtailment or default.

• export_curtailment means that we will try to keep the grid export at 0 kW during the scheduled times by curtailing the pv production if needed.

• production_curtailment means that we will try to keep the pv production at 0 kW during the scheduled times by curtailing the pv production if needed.

• default means that we will not curtail the pv production or export and allow the grid export to be determined by the household consumption and pv production. If the end_time of default control type is reached, it will keep it as default unless another schedule overwrites it.

• It is possible to not provide an end_time for a schedule entry. We will handle this then as start command without reverting back to it’s original state. This is mostly recommended if you want the user to go to it’s default state. NOTE:

• The pv device might need some time to react. Please provide start times at least 1 minute in the future to ensure the device can react in time. Some may react slower than others.

POST /v1/devices/pv/schedules

Post Pv Control Schedule

cURL

curl --request POST \
  --url https://api.nox.energy/v1/devices/pv/schedules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
[
  {
    "device_id": "PV1",
    "schedules": [
      {
        "start_time": "2025-08-05T10:15:00Z",
        "end_time": "2025-08-05T10:20:00Z",
        "control_type": "export_curtailment"
      }
    ]
  },
  {
    "device_id": "PV2",
    "schedules": [
      {
        "start_time": "2025-08-05T10:15:00Z",
        "end_time": "2025-08-05T10:20:00Z",
        "control_type": "production_curtailment"
      }
    ]
  },
  {
    "device_id": "PV3",
    "schedules": [
      {
        "start_time": "2025-08-05T10:15:00Z",
        "control_type": "default"
      }
    ]
  },
  {
    "device_id": "PV4",
    "schedules": [
      {
        "start_time": "2025-08-05T10:15:00Z",
        "end_time": "2025-08-05T10:20:00Z",
        "control_type": "export_curtailment"
      },
      {
        "start_time": "2025-08-05T10:21:00Z",
        "end_time": "2025-08-05T10:25:00Z",
        "control_type": "production_curtailment"
      }
    ]
  }
]
'

200

{
  "rejected": [],
  "meta": {
    "energy_supplier": "Energy Supplier A",
    "accepted_count": 12,
    "rejected_count": 0
  }
}

Authorizations

x-api-key · string · header · required

API Key authentication. Enter your API key in the format: YOUR_API_KEY

Body

application/json

device_id · string · required

Device ID to update control commands for it.

schedules · PVScheduleEntry · object[] · required

List of commands to schedule for the pv device.

Show child attributes

Response

200

application/json

All schedules accepted successfully

meta · DevicesPVSchedulenMeta · object · required

Show child attributes

rejected · DevicesPVScheduleRejectedListResponse · object

List of device IDs for which the schedule could not be applied.

Show child attributes