Model inference
Perform inference with foundation models.
query Parameters
modelstringย ยทย enumย ยทย requiredThe forecasting model to use for inference. Note that only
tabpfn-ts,moiraiandmoirai-moesupport exogenous variables.Enum values:moiraichronoschronos-bolttimesfmtimesfm-2moirai-moemoirai-2tabpfn-tsDefault: tabpfn-tscloudstringย ยทย enumSpecify the cloud provider to use for inference. If none is set then any may be used depending on availability.
Enum values:gcpawsoci
Headers
Authorizationstringย ยทย requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
seriesobject[]ย ยทย requiredExample: {"0":{"future_variables":{"local_attendance_forecast":[125,75,200,122,123,150,100,120,121,119]},"future_variables_index":["2001-01-06","2001-01-07","2001-01-08","2001-01-09","2001-01-10","2001-01-11","2001-01-12","2001-01-13","2001-01-14","2001-01-15"],"hist_variables":{"temperature":[74,72,79,77,75]},"index":["2001-01-06","2001-01-07","2001-01-08","2001-01-09","2001-01-10"],"static_variables":{"Population":100000},"target":[125,120,140,135,133]}}horizonintegerย ยทย min: 1ย ยทย max: 10000ย ยทย requiredNumber of steps to forecast given the frequency.
Example: 5freqstringย ยทย enumย ยทย requiredFrequency of the time series.
Enum values:5min15min30minHDWMQExample: D
contextThe amount of history to use when forecasting. This is the number of steps to look back in the target series. More history can improve the forecast accuracy, but can also increase the computation time. By default this is set to the max of model capability or the length of the provided target series, whichever is shorter.
Example: 20Default: nullquantilesDefault: [0.1,0.9,0.4,0.5]covariatesApply additional co-variates provided by TFC. Only supported by the following models: Navi, Moirai, Moriai-MoE and TabPFN-TS.
Example: {"0":{"config":{"country":"US"},"type":"holidays"}}Default: nullmodel_configOptional model-specific configuration overrides.
Example: {"config":{"season_length":7},"model":"aarima"}Default: null
Responses
Success
seriesDefault: nullstatusDefault: completed
Submit job for forecasting
Perform historic inference for a range of forecast creation dates (fcds). These jobs can run longer and need to be retrieved with a separate endpoint and the returned job ID.
query Parameters
modelstringย ยทย enumย ยทย requiredThe forecasting model to use for inference. Note that only
tabpfn-ts,moirai, andmoirai-moesupport exogenous variables.Enum values:moiraichronoschronos-bolttimesfmtimesfm-2moirai-moemoirai-2tabpfn-tsDefault: tabpfn-ts
Headers
Authorizationstringย ยทย requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
seriesobject[]ย ยทย requiredExample: {"0":{"future_variables":{"local_attendance_forecast":[125,75,200,122,123,150,100,120,121,119]},"future_variables_index":["2001-01-06","2001-01-07","2001-01-08","2001-01-09","2001-01-10","2001-01-11","2001-01-12","2001-01-13","2001-01-14","2001-01-15"],"hist_variables":{"temperature":[74,72,79,77,75]},"index":["2001-01-06","2001-01-07","2001-01-08","2001-01-09","2001-01-10"],"static_variables":{"Population":100000},"target":[125,120,140,135,133]}}horizonintegerย ยทย min: 1ย ยทย max: 10000ย ยทย requiredNumber of steps to forecast given the frequency.
Example: 5freqstringย ยทย enumย ยทย requiredFrequency of the time series.
Enum values:5min15min30minHDWMQExample: D
contextThe amount of history to use when forecasting. This is the number of steps to look back in the target series. More history can improve the forecast accuracy, but can also increase the computation time. By default this is set to the max of model capability or the length of the provided target series, whichever is shorter.
Example: 20Default: nullquantilesDefault: [0.1,0.9,0.4,0.5]covariatesApply additional co-variates provided by TFC. Only supported by the following models: Navi, Moirai, Moriai-MoE and TabPFN-TS.
Example: {"0":{"config":{"country":"US"},"type":"holidays"}}Default: nullmodel_configOptional model-specific configuration overrides.
Example: {"config":{"season_length":7},"model":"aarima"}Default: null
Responses
Job submitted successfully
call_idstringThe unique identifier of the submitted job
Retrieve job result
Retrieve the forecast result from a forecast job.
path Parameters
job_idstringย ยทย required
Headers
Authorizationstringย ยทย requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
seriesDefault: nullstatusDefault: completed
Warmup model
Warmup a model endpoint for better UX in embedded applications.
query Parameters
modelstringย ยทย enumย ยทย requiredThe forecasting model to warmup.
Enum values:moiraichronoschronos-bolttimesfmtimesfm-2moirai-moemoirai-2tabpfn-tsDefault: tabpfn-tscloudstringย ยทย enumSpecify the cloud provider to use. If none is set then any may be used depending on availability.
Enum values:gcpawsoci
Headers
Authorizationstringย ยทย requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typestringย ยทย requiredA URI reference that identifies the problem.
titlestringย ยทย requiredA short, human-readable summary of the problem.
statusnumberย ยทย requiredThe HTTP status code.
instancestring

