Model builders

Build a parameter set from a cell spec

Changed on

Build the model's parameters for a cell spec; with save, store them as a parameterized model.

post/model_builders/{model_builder_id}/build

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/model_builders/{model_builder_id}/build
  • Auth
    none declared

Path parameters

model_builder_idstring uuid required

Request body

cell_spec_idstring required
saveboolean

Save the result as a parameterized model on the cell spec.

namestring nullable

Name for the saved parameterized model. Required with save.

descriptionstring nullable
set_as_defaultboolean

Make the saved model the cell spec's default parameterized model.

Response

Successful Response

parametersobject required

Parameter values, in the parameterized-model storage format.

missingstring[]

Parameters the model needs that the builder did not produce.

parameterized_model_idstring nullable

The saved parameterized model, when save was set.

Changes