Sign in

v1

latestOpenAPI 3.0.12026-07-178827.6 KB
CarbonAware

Given an array of request objects, each with their own location and time boundaries, calculate the average carbon intensity for that location and time period and return an array of carbon intensity objects.

The application only supports batching across a single location with different time boundaries. If multiple locations are provided, an error is returned. For each item in the request array, the application returns a corresponding object containing the location, time boundaries, and average marginal carbon intensity.

post/emissions/average-carbon-intensity/batch

Request body

locationstring nullable

The location name where workflow is run

startTimestring date-time nullable

The time at which the workflow we are measuring carbon intensity for started

endTimestring date-time nullable

The time at which the workflow we are measuring carbon intensity for ended

Example request

[
  {
    "location": "eastus",
    "startTime": "2022-03-01T15:30:00Z",
    "endTime": "2022-03-01T18:30:00Z"
  }
]

Response

Returns an array of objects where each contains location, time boundaries and the corresponding average marginal carbon intensity

locationstring nullable

the location name where workflow is run

startTimestring date-time nullable

the time at which the workflow we are measuring carbon intensity for started

endTimestring date-time nullable

the time at which the workflow we are measuring carbon intensity for ended

carbonIntensitynumber double

Value of the marginal carbon intensity in grams per kilowatt-hour.

Example response

[
  {
    "location": "eastus",
    "startTime": "2022-03-01T15:30:00Z",
    "endTime": "2022-03-01T18:30:00Z",
    "carbonIntensity": 345.434
  }
]