v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB

Models

Update Model

Partially updates an existing forecast model. Only the fields provided in the request body will be changed. 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.

patch/v1/forecasts/models/{model_id}

Path parameters

model_idstring required

The unique identifier of the forecast model.

Request body

namestring nullable

Name for the forecast model.

external_idstring nullable

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

forecast_window'1d' | '7d' | '14d' | '28d' | '30d' | '60d' | '90d'

generate_baselineboolean

When true, generates a baseline model using historical demand data only - without PredictHQ demand intelligence - for benchmarking accuracy against the enhanced model.

labelstring[] nullable

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

algo'phq-xgboost'

Response

Successful Response