Submit Forecast From Storage Object

POST /forecast/storage-object

Submit Forecast From Storage Object

cURL

curl --request POST \
  --url https://eomer-api.onrender.com/forecast/storage-object \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "object_id": "<string>",
  "prediction_length": 24,
  "presets": "small",
  "item_id_column": "item_id",
  "timestamp_column": "timestamp",
  "target_column": "target",
  "freq": "<string>",
  "quantile_levels": "<string>",
  "covariates": "<string>",
  "latitude": 123,
  "longitude": 123,
  "feature_engineering": {
    "enabled": true,
    "time_features": true,
    "cyclical_encoding": true,
    "lag_features": true,
    "lag_periods": [
      1,
      7,
      14,
      30
    ],
    "rolling_features": true,
    "rolling_windows": [
      3,
      7,
      14,
      30
    ],
    "rolling_stats": [
      "mean",
      "std",
      "min",
      "max"
    ],
    "growth_features": true,
    "growth_periods": [
      1,
      7
    ],
    "event_flags": true
  },
  "external_covariates": {
    "weather": {
      "enabled": false,
      "variables": [
        "<string>"
      ],
      "city": "<string>",
      "latitude_column": "<string>",
      "longitude_column": "<string>",
      "latitude": 123,
      "longitude": 123,
      "resolved_location": {
        "query": "<string>",
        "name": "<string>",
        "latitude": 123,
        "longitude": 123,
        "country": "<string>",
        "admin1": "<string>",
        "timezone": "<string>"
      }
    },
    "holidays": {
      "enabled": false,
      "variables": [
        "<string>"
      ],
      "country_code": "<string>",
      "subdivision_code": "<string>"
    },
    "fred": {
      "enabled": false,
      "variables": [
        "<string>"
      ],
      "future_strategy": "forward_fill_latest"
    }
  },
  "explainability": {
    "enabled": false,
    "feature_importance": true,
    "shap": true,
    "feature_feature_correlations": true,
    "feature_target_correlations": true,
    "forecast_plot": true,
    "rolling_regression": true,
    "trailing_history_steps": 123,
    "max_rows": 5000,
    "max_features": 25,
    "top_k_features": 15,
    "shap_sample_size": 512
  },
  "callback_url": "<string>"
}
'

202

{
  "job_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "elapsed_seconds": 123,
  "num_items": 123,
  "prediction_length": 123,
  "error": "<string>",
  "download_url": "<string>",
  "report_url": "<string>",
  "external_covariate_metadata": {},
  "explainability": {
    "enabled": false,
    "overview_markdown": "",
    "selected_analyses": [
      "<string>"
    ],
    "completed_analyses": [
      "<string>"
    ],
    "skipped_analyses": {},
    "warnings": [
      "<string>"
    ],
    "artifacts": [
      {
        "artifact_id": "<string>",
        "analysis": "<string>",
        "label": "<string>",
        "format": "<string>",
        "output_path": "<string>",
        "download_url": "<string>",
        "embed_url": "<string>",
        "description": "",
        "render_inline": false,
        "preview_markdown": "",
        "highlights": [
          "<string>"
        ],
        "display_order": 0,
        "is_primary_visual": false,
        "is_thumbnail": false
      }
    ],
    "summary_path": "<string>"
  },
  "explainability_url": "<string>",
  "forecast_plot_url": "<string>",
  "request_id": "<string>",
  "config_hash": "<string>",
  "dataset_hash": "<string>",
  "model_version": "<string>",
  "delivery_status": "<string>",
  "delivery_connection_id": "<string>",
  "delivery_uri": "<string>",
  "delivery_error": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for submitting a forecast job from a stored object.

object_id · string · required

Required string length: 1 - 128

prediction_length · integer · default: 24

Required range: x >= 1

presets · string · default: small

Required string length: 1 - 128

item_id_column · string · default: item_id

Required string length: 1 - 200

timestamp_column · string · default: timestamp

Required string length: 1 - 200

target_column · string · default: target

Required string length: 1 - 200

freq · string | null

Maximum string length: 20

quantile_levels · string | null

Maximum string length: 200

covariates · string | null

Maximum string length: 500

latitude · number | null

longitude · number | null

feature_engineering · FeatureEngineeringConfig · object

Internal covariate generation from the dataset itself.

When enabled, deterministic features (calendar, cyclical encodings, lag, rolling statistics, growth metrics, and event flags) are generated and injected as covariates before model fitting.

Show child attributes

external_covariates · ExternalCovariatesConfig · object

External covariate source settings.

Show child attributes

explainability · ExplainabilityConfig · object

Optional post-forecast explainability analyses and artifacts.

Show child attributes

callback_url · string | null

Maximum string length: 2048

Response

202

application/json

Successful Response

Response model for job status queries.

job_id · string · required

status · enum<string> · required

Status values for async forecast jobs.

Available options: pending, running, completed, failed

created_at · string<date-time> · required

completed_at · string<date-time> | null

elapsed_seconds · number | null

num_items · integer | null

prediction_length · integer | null

error · string | null

error_code · enum<string> | null

Machine-readable error codes for agent-friendly error handling.

Available options: validation_error, invalid_preset, file_too_large, rate_limited, server_overloaded, job_not_found, job_not_completed, auth_failed, internal_error, timeout, pipeline_failed, storage_error, gpu_offload_unavailable, connection_not_found, connector_error, sandbox_domain_used, sandbox_captcha_failed, sandbox_dataset_too_large, sandbox_corporate_email_required

download_url · string | null

report_url · string | null

external_covariate_metadata · External Covariate Metadata · object

explainability · ExplainabilitySummaryResponse · object

Explainability execution status for a forecast job.

Show child attributes

explainability_url · string | null

forecast_plot_url · string | null

request_id · string | null

config_hash · string | null

dataset_hash · string | null

model_version · string | null

delivery_status · string | null

delivery_connection_id · string | null

delivery_uri · string | null

delivery_error · string | null