Skip to main content
Get a parameterized model by id

Path Parameters

parameterized_model_id
string<uuid>
required

Query Parameters

summary
boolean
default:false

Return id, name, cell spec, base model and timestamps only, without the parameter values.

Response

Successful Response

model
Model · object
required

Model info with id and name (loaded from models table via join).

parameters
Parameters · object
required

Model parameters.

id
string
required

Unique identifier for the parameterized model.

name
string
required

Human-readable name of the parameterized model.

project_id
string
required

Owning project ID, denormalized from the cell specification for models that have one, and supplied directly by the caller for quick models that do not.

organization_id
string
required

Owning organization ID.

url
string | null
api_url
string | null
simulation_settings
Simulation Settings · object | null

Optional parameter-specific simulation kwargs.

description
string | null

Optional description of the parameterized model.

cell_spec_id
string | null

Associated cell specification ID.

created_at
string<date-time> | null

When the parameterized model was created.

updated_at
string<date-time> | null

When the parameterized model was last updated.

created_by
string | null

User ID of the creator.

source_model_builder_id
string | null

Model builder that produced these parameters.

build_provenance
Build Provenance · object | null

Builder config snapshot and resolved cell-spec hash it ran on.

parent_parameterized_model_id
string | null

Parameterized model this one is a new version of; null for a root.

family_id
string | null

Family this model is a version of; null until it has one.

version_number
integer | null

Position in the family, 1 for the first version.

is_current_version
boolean
default:true

Whether this is its family's current version: the newest, unless an older one was restored since.

parameter_symbols
Parameter Symbols · object | null

Display symbols overriding the defaults, by parameter name.