Skip to main content

Aliases: stable names for workflows and models

Name a workflow by its slug and a model by its family; the API resolves each to an exact version and says which in its answer. Pin a version when a result must not move under you. Routes that were renamed still answer at their old paths, marked deprecated.

Workflow slugs​

A slug is a name you choose: lowercase letters, digits and -, up to 63 characters, starting with a letter or digit. Each save of a slug is its next version, numbered from 1, and a version never changes once saved.

You sendResolves to
workflow alone, on POST /predictionsThe latest version when the run is submitted
workflow alone, on GET /predictionsThe newest finished forecast of the latest version
workflow with workflow_versionThat version
network_config_version left out, on POST /predictionsYour latest network config when the run is submitted

The run records what it resolved to: workflow_version, network_config_version, and the asset catalog and orbit snapshots it read. Every item carries workflow_version. So a later save never changes what an earlier run meant.

A template's slug, such as pass-yield, names a workflow only once you have saved one under it. Until then a run of it is 404 unknown_workflow; see the template catalog.

Model families and releases​

model_family on GET /predictions names a model; in a workflow, the lane of the same model has a shorter name for one of them.

Modelmodel_familyWorkflow lane
Link SNRsnrsnr
Weather attenuationweather-attenuationweather
Satellite demanddemanddemand
RF interferencerfirfi
SSA pass forecastssassa

snr-v2 is a deprecated name for snr: the API answers it as snr.

A family resolves to the release that serves it to your account when you ask, and each item names that release in model_release_id. You cannot pin a release. A family your deployment does not serve answers 404 model_family_not_available.

In a workflow run, each lane's source in explain says what priced it: a physics baseline such as physics:clear-sky-budget or climatology, or a model as model:<family>:<release id>, the release that served it. See Items for the reasons a lane stays on its baseline.

Renamed routes​

The old paths still answer as they did before the move, with two headers that name the new path: Deprecation: true and Link: <new path>; rel="successor-version". Move to the new path; the old ones are not documented beyond this table.

Old pathNew path
PUT /raw-data/{source}/{name}, GET /raw-data, GET /raw-data/whoami/telemetry/files/...
GET, PUT and PATCH /network-config/topology/config
POST /v2/telemetryPOST /telemetry
GET /v2/telemetryGET /topology/series
GET /v2/topologyGET /topology, whose state holds what it returned

/predict is another name for /predictions, for GET and POST, and is not deprecated.

One query parameter was retired: GET /predictions with live answers 400 unknown_query_parameter.