Forecasting APIby Birla AI Labs
Get API key
POSTapi.oab-forecasting.com/v1/forecast-jobs

Submit Forecast Job

Queue a long-running forecast and receive a job identifier immediately. Use this endpoint when you want explicit asynchronous submission; the adaptive /forecast endpoint may also return HTTP 202 for deferred workloads.

View code & Try it

Request Schema

modelstringrequiredModel ID or supported alias. Toto checkpoints use toto-2 or toto-2-ft.
targetarray[number]requiredFinite values to forecast.
indexarray[string]requiredStrictly ascending ISO dates or datetimes matching target length.
hist_variablesobject<string, array[number]>optionalHistorical covariates; every array matches target length.
future_variablesobject<string, array[number]>optionalFuture covariates; every array matches horizon.
future_variables_indexarray[string]optionalFuture-covariate timestamps matching horizon.
static_variablesobjectoptionalScalar covariates for the series.
horizonintegerrequiredForecast steps, bounded by the selected model.
freqfrequencyrequired5min, 15min, 30min, H, D, W, M, MS, Q, or Y.
contextintegeroptionalHistory steps supplied to the model.
quantilesarray[number]optionalValues strictly between 0 and 1. Defaults to every decile from 0.1 through 0.9.
model_sizestringoptionalSize for a multi-size model. Both Toto-2 checkpoints use the fixed 2.5b size.
modelstringModel implementation selected for the override.
configobjectConfiguration values passed to the selected model.
seedintegeroptionalReproducibility seed; default 42.
allow_truncationbooleanoptionalAllow context-window trimming; default false.

Response Schema

job_idstringrequired
statusqueuedrequired
modelstringrequired
poll_urlstringrequiredSame-API URL used to poll the job.

Response Example

{
  "job_id": "e4ba080c-129a-4c48-8224-1b39a26ece9a",
  "status": "queued",
  "model": "yug",
  "poll_url": "/v1/forecast-jobs/e4ba080c-129a-4c48-8224-1b39a26ece9a"
}

Possible Errors

401UnauthorizedThe API key is missing, expired, revoked, or invalid.
413Context too largeA series exceeds the selected model context and truncation is disabled.
422Validation errorThe request or model configuration is invalid.
429Limit exceededA request-rate or forecast quota was exceeded.
503Dependency unavailableA quota, queue, storage, or inference dependency is temporarily unavailable.
409Idempotency conflictThe key was already used for a different payload.
import requests

response = requests.post(
    "https://api.oab-forecasting.com/v1/forecast-jobs",
    headers={"Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Idempotency-Key": "unique-request-key"},
    json={
  "model": "yug",
  "model_size": "base",
  "series": [
    {
      "target": [
        120.5,
        132.1,
        118.3,
        141,
        155.2
      ],
      "index": [
        "2024-01-01",
        "2024-01-02",
        "2024-01-03",
        "2024-01-04",
        "2024-01-05"
      ]
    }
  ],
  "horizon": 2,
  "freq": "D",
  "quantiles": [
    0.1,
    0.2,
    0.3,
    0.4,
    0.5,
    0.6,
    0.7,
    0.8,
    0.9
  ]
},
)
response.raise_for_status()
print(response.json())
POSTapi.oab-forecasting.com/v1/forecast-jobs

Submit Forecast Job

Queue a long-running forecast and receive a job identifier immediately. Use this endpoint when you want explicit asynchronous submission; the adaptive /forecast endpoint may also return HTTP 202 for deferred workloads.

View code & Try it

Request Schema

modelstringrequiredModel ID or supported alias. Toto checkpoints use toto-2 or toto-2-ft.
targetarray[number]requiredFinite values to forecast.
indexarray[string]requiredStrictly ascending ISO dates or datetimes matching target length.
hist_variablesobject<string, array[number]>optionalHistorical covariates; every array matches target length.
future_variablesobject<string, array[number]>optionalFuture covariates; every array matches horizon.
future_variables_indexarray[string]optionalFuture-covariate timestamps matching horizon.
static_variablesobjectoptionalScalar covariates for the series.
horizonintegerrequiredForecast steps, bounded by the selected model.
freqfrequencyrequired5min, 15min, 30min, H, D, W, M, MS, Q, or Y.
contextintegeroptionalHistory steps supplied to the model.
quantilesarray[number]optionalValues strictly between 0 and 1. Defaults to every decile from 0.1 through 0.9.
model_sizestringoptionalSize for a multi-size model. Both Toto-2 checkpoints use the fixed 2.5b size.
modelstringModel implementation selected for the override.
configobjectConfiguration values passed to the selected model.
seedintegeroptionalReproducibility seed; default 42.
allow_truncationbooleanoptionalAllow context-window trimming; default false.

Response Schema

job_idstringrequired
statusqueuedrequired
modelstringrequired
poll_urlstringrequiredSame-API URL used to poll the job.

Response Example

{
  "job_id": "e4ba080c-129a-4c48-8224-1b39a26ece9a",
  "status": "queued",
  "model": "yug",
  "poll_url": "/v1/forecast-jobs/e4ba080c-129a-4c48-8224-1b39a26ece9a"
}

Possible Errors

401UnauthorizedThe API key is missing, expired, revoked, or invalid.
413Context too largeA series exceeds the selected model context and truncation is disabled.
422Validation errorThe request or model configuration is invalid.
429Limit exceededA request-rate or forecast quota was exceeded.
503Dependency unavailableA quota, queue, storage, or inference dependency is temporarily unavailable.
409Idempotency conflictThe key was already used for a different payload.