Skip to main content
Get a specific model by ID within an organization

Path Parameters

model_id
string<uuid>
required

Response

Successful Response

name
string
required

The name of the model.

id
string
required

The unique identifier for the model.

organization_id
string
required

The ID of the organization this model belongs to.

created_at
string<date-time>
required

Timestamp of when the model was created.

updated_at
string<date-time>
required

Timestamp of when the model was last updated.

config
Config · object
required

Model configuration stored as JSON.

is_custom_model
boolean
required
read-only

Check if this is a custom model (has compressed model data).

url
string | null
api_url
string | null
description
string | null

An optional description for the model.

pybamm_version
string | null

PyBaMM version used for this model. If not provided, will be read from pybamm.version.

chemistry
enum<string>
default:lithium_ion

Model chemistry kind: 'lithium_ion' (default — assumes pybamm lithium-ion conventions), 'lithium_sulfur', 'ecm', or 'generic' (no chemistry-specific enrichment).

Available options:
lithium_ion,
lithium_sulfur,
ecm,
generic
simulation_settings
Simulation Settings · object | null

Optional persistent simulation kwargs (var_pts / submesh_types / spatial_methods / geometry / solver) in the flat canonical form, re-applied at simulation time. None uses the model defaults.

project_id
string | null

Project this model belongs to. None only for the shared system catalog.

user_id
string | null

The ID of the user who created the model. None once that account is deleted.

source_model_id
string | null

For a project's copy of a system model, the system model it was copied from. None for a model the project made itself.

created_by_email
string | null

Email of the user who created the model.