User GuideAPI ReferenceDSLWhat's NewChangelog
API Reference

Run prediction model

post
https://analytics.api.exabel.com/v1/predictionModels//runs

Returns the exact run name and the requested options. Poll GetPredictionModelRun for execution state, timestamps, and the saved configuration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of a prediction model, e.g. 123.

Body Params

The model run.

A prediction model run.

string

You may use this to record some notes about the run. This is shown in the prediction model interface when viewing all runs, and when viewing the results of a single run.

string
enum
Defaults to MODEL_CONFIGURATION_NOT_SPECIFIED

Which model configuration to use. If not specified, the latest model configuration is used. Note that the current signal library is always loaded.

  • MODEL_CONFIGURATION_NOT_SPECIFIED: Not specified - defaults to use the latest configuration.
  • LATEST: Latest configuration.
  • ACTIVE: Configuration of the active run. A specific run may be activated from the prediction model user interface.
  • SPECIFIC_RUN: Configuration of a specific run. The run number must be specified as well.
Allowed:
int32

Prediction model run number from which model configuration should be retrieved, e.g. 1. Only relevant when configuration is set to ModelConfiguration.SPECIFIC_RUN.

boolean

Whether to automatically set this run as active once it completes. The run will not be activated if it fails for any of the entities in the model.

string
enum
Defaults to PREDICTION_MODEL_RUN_STATE_UNSPECIFIED

Aggregate execution state of a run or a recorded entity outcome.

  • PREDICTION_MODEL_RUN_STATE_UNSPECIFIED: No recognized execution state is available.
  • WAITING: Waiting for prerequisites before scheduling.
  • SCHEDULED: Queued for execution.
  • RUNNING: Execution has started and has not completed.
  • SUCCEEDED: Execution completed successfully.
  • FAILED: Execution failed.
  • CANCELLED: Execution was cancelled.
  • MIXED: The run completed with both successful and failed outcomes.
  • TIMED_OUT: Execution exceeded its time limit.
  • OUT_OF_MEMORY: Execution exhausted its available memory.
modelConfiguration
object

Inputs, algorithm, training period, and evaluation settings of a saved prediction model. Saving configuration does not start a run. Unsupported configurations remain inspectable; check the enclosing resource's configurationWritable before submitting configuration changes.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?