Replace Model

Replace an existing forecast model.

Replace Model

put

Replaces the full configuration of an existing forecast model. This is a full replacement — all mutable fields should be provided. Changes to location, demand_type, forecast_window, algo, or generate_baseline are blocked while the model is in preparing, training, or forecasting status. Changing any of those fields sets the model to stale status, requiring re-training to take effect.

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your PredictHQ API key. The Bearer prefix is added automatically.

When calling the API directly, send: Authorization: Bearer <YOUR_API_KEY> as documented at https://docs.predicthq.com/api/overview/authenticating

Path parameters

model_idstringRequired

The unique identifier of the forecast model.

Body

application/json

namestring · min: 1Required

Name for the forecast model.

external_idstring · min: 1 · nullableOptional

User-provided external identifier for cross-referencing with other systems.

forecast_windowstring · enum · nullableOptional

Number of days into the future to forecast.

Possible values:

labelstring[] · min: 1 · nullableOptional

Set of labels you can use to better identify or group your forecast models.

algoconst: phq-xgboostOptional

Algorithm to use for forecasting.

Default: phq-xgboost

Responses

204

Successful Response

No content

400

Bad Request

application/json

401

Unauthorized

application/json

402

Payment Required

application/json

403

Forbidden

application/json

404

Not Found

application/json

put/v1/forecasts/models/{model_id}

HTTPcURLJavaScriptPython

PUT /v1/forecasts/models/{model_id} HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "name": "text",
  "external_id": "text",
  "forecast_window": "1d",
  "label": [
    "text"
  ],
  "location": {
    "saved_location_id": "text"
  },
  "algo": "phq-xgboost",
  "demand_type": {
    "interval": "text",
    "industry": "accommodation"
  }
}

No content

OpenAPI Spec

The OpenAPI spec for Forecasts API can be found here.

Guides

• Getting Started with Forecasts API
• Understanding Forecast Accuracy Metrics
• Troubleshooting Guide for Forecasts API