Skip to main content
POST
/
forecaster
/
{id}
/
forecast
Generate forecast
curl --request POST \
  --url https://api.omnifuel.ai/v1/forecaster/{id}/forecast \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "steps": 123,
  "dataset": "<string>",
  "dataset_format": "csv"
}
'
"[{\"step\":1,\"value\":123.45},{\"step\":2,\"value\":130.67}]"

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of the trained model to be used for forecasting.

Body

application/json
​
steps
number
required

Number of forecast steps to predict.

​
dataset
string
required

Location of the dataset to be used for generating the forecast.

​
dataset_format
enum<string>
default:csv

Format of the dataset.

Available options:
csv,
parquet

Response

Forecast generated successfully

The forecast data in JSON format.