Get model

Get an existing forecast model.

Get Model

get

Retrieves a single forecast model by ID, including its current readiness status, configuration, accuracy metrics, and location details.

Authorizations

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.

Responses

200

Successful Response

application/json

errorsstring[]Optional

List of error messages, if any.

Default: []

warningsstring[]Optional

List of warning messages, if any.

Default: []

401

Unauthorized

application/json

402

Payment Required

application/json

403

Forbidden

application/json

404

Not Found

application/json

get/v1/forecasts/models/{model_id}

GET /v1/forecasts/models/{model_id} HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "errors": [
    "text"
  ],
  "warnings": [
    "text"
  ],
  "model": {
    "algo": "text",
    "create_dt": "2026-01-01T00:00:00.000Z",
    "demand_type": {
      "interval": "text",
      "industry": "accommodation"
    },
    "external_id": "text",
    "forecast_window": "1d",
    "label": [
      "text"
    ],
    "location": {
      "saved_location_id": "text"
    },
    "metrics": {
      "accuracy": {
        "mape": 1,
        "mae": 1,
        "rmse": 1,
        "wape": 1
      },
      "demand_data": {
        "date_range": {
          "start": "2026-01-01",
          "end": "2026-01-01"
        }
      },
      "training_data": {
        "date_range": {
          "start": "2026-01-01",
          "end": "2026-01-01"
        },
        "missing_pct": 0,
        "missing_dates": [
          "2026-01-01"
        ]
      }
    },
    "model_id": "text",
    "name": "text",
    "readiness": {
      "status": "created",
      "error_code": "text",
      "error_message": "text"
    },
    "train_dt": "2026-01-01T00:00:00.000Z",
    "update_dt": "2026-01-01T00:00:00.000Z"
  }
}

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