Model builders

Run an unsaved model builder config against a cell spec

Changed on

Check and build a config without saving the builder or any parameterized model.

post/model_builders/dry_run

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/model_builders/dry_run
  • Auth
    none declared

Request body

model_idstring required
configobject required

Builder config, as it would be saved (Pipeline config).

cell_spec_idstring required

Response

Successful Response

parametersobject

Parameter values the recipe produced; empty when not ready.

missingstring[]

Parameters the model needs that the config did not produce.

valuesobject

Each produced parameter that evaluates to a number, e.g. an expression such as 1 - porosity.

errorstring nullable

Why the calculations failed, when they did.

Changes