Replace Model

Replace an existing forecast model.

Public Preview

Forecasts API is now available in Public Preview to all customers until May 31, 2025. The underlying algorithm and functionality has been thoroughly tested in production use-cases and is now available to be used to improve forecast accuracy for your business.

Replace Model

put

Authorizations

Path parameters

model_idstringRequired

Body

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

HTTPcURLJavaScriptPython

PUT /v1/forecasts/models/{model_id} HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer $API_KEY
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