Model Forecasts

Post Model Forecast

Write back one issue of a rebase model forecast for a zone.

Internal only: accepted on the dev API (internal scope); the public prod API returns 403. One request is one forecast issue — every point shares the body's issue_time, which becomes the snapshot's knowledge time so successive hourly issues are all preserved.

Validation: the zone must exist (404), data.datetime and data.value_mw must have equal length, and every datetime must be timezone-aware (naive datetimes are rejected with 422).

post/v1/zone/{zone_key}/forecast

Request

  • Base URL: https://grid.rebase.energy/api
  • URL: https://grid.rebase.energy/api/v1/zone/{zone_key}/forecast
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-API-Key

Path parameters

zone_keystring required

Request body

variable'demand' | 'wind' | 'solar' required
modelstring required

Model name. Normalised to a slug for series identity (lowercase, non-alphanumeric runs become '-').

issue_timestring date-time required

When this forecast was issued (tz-aware). Stored as the snapshot's knowledge_time so successive issues are preserved.

Response

Successful Response

status'ok' required
zone_keystring required
variable'demand' | 'wind' | 'solar' required
modelstring required

Model slug the points were stored under.

issue_timestring required

Echo of the stored issue time (ISO 8601).

pointsinteger required

Number of forecast points accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.