List models

GET/v1/models

Returns the Stochio models, available or announced, with their limits. Use it to check which models you can call.

Headers

AuthorizationstringRequired

Bearer followed by your API key.

Returns

models, an array with one object per model:

idstring

Unique model identifier, to pass as model.

namestring

Human-readable model name.

descriptionstring

Short description of the model.

status"available" or "soon"

"available" models can be used. "soon" models are announced: they are listed, but POST /v1/forecast rejects them.

max_contextnumber

Maximum number of bars the model reads.

max_horizonnumber

Maximum number of bars to forecast. Your plan may allow fewer.

max_samplesnumber

Maximum number of sample paths. Your plan may allow fewer.

default_samplesnumber

Number of sample paths drawn when sample_count is omitted.

horizonsarray of number

Horizons the model was trained on. Any horizon up to max_horizon is accepted.

quantilesarray of number

Levels offered in the playground. Any level strictly between 0 and 1 is accepted.

default_quantilesarray of number

Levels returned when quantiles is omitted.

default_mean_shrinknumber

Recentring applied when mean_shrink is omitted.

Errors

401 invalid_api_key: the API key is missing, invalid, revoked or expired.

Example

curl https://api.stochio.fr/v1/models \
  -H "Authorization: Bearer $STOCHIO_API_KEY"

Response

{
  "models": [
    {
      "id": "stochio-small-1",
      "name": "Stochio Small",
      "description": "Foundation model for financial time series: probabilistic forecasts of OHLCV candles, from sampled paths.",
      "status": "available",
      "max_context": 512,
      "max_horizon": 48,
      "max_samples": 256,
      "default_samples": 16,
      "horizons": [1, 8, 24, 48],
      "quantiles": [0.1, 0.25, 0.5, 0.75, 0.9],
      "default_quantiles": [0.1, 0.5, 0.9],
      "default_mean_shrink": "..."
    },
    {"id": "stochio-medium-1", "name": "Stochio Medium", "status": "soon", "...": "..."}
  ]
}