Replace Model

Replace an existing forecast model.

Replace Model

put

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

Body

application/json

namestring · min: 1Required

external_idany ofOptional

string · min: 1Optional

or

nullOptional

forecast_windowany ofOptional

string · enumOptionalPossible values:

or

nullOptional

labelany ofOptional

string[] · min: 1Optional

or

nullOptional

algostring · enumOptionalDefault: phq-xgboostPossible values:

demand_typeany ofOptional

or

nullOptional

Responses

204

Successful Response

422

Validation Error

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: 197

{
  "name": "text",
  "external_id": "text",
  "forecast_window": "1d",
  "label": [
    "text"
  ],
  "location": {
    "saved_location_id": "text"
  },
  "algo": "phq-xgboost",
  "demand_type": {
    "interval": "day",
    "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