Models

Method	Description
list_models	List models.
iter_models	Iterate over models.
get_model	Get a model by SID.
create_empty_model	Create an empty computational model with no content.
create_model_from_json	Create a computational model from a raw JSON payload.

list_models

list_models(
    *,
    name: str | None = None,
    folder: Folder | str | None = None,
    limit: int | None = None,
    deleted: bool = False,
    after: str | None = None
) -> Page[Model]

List models.

Parameters:

Name	Type	Description	Default
name	str | None	Optional name filter.	None
folder	Folder | str | None	Optional folder filter.	None
limit	int | None	Maximum number of results to return.	None
deleted	bool	Whether to include deleted models.	False
after	str | None	Pagination cursor.	None

Returns:

• Page[Model]: A page of Model objects.

iter_models

iter_models(
    *,
    name: str | None = None,
    folder: Folder | str | None = None,
    deleted: bool = False
) -> Iterator[Model]

Iterate over models.

Parameters:

Name	Type	Description	Default
name	str | None	Optional name filter.	None
folder	Folder | str | None	Optional folder filter.	None
deleted	bool	Whether to include deleted models.	False

Yields:

• Model: Model objects.

get_model

get_model(
    sid: str, *, revision: int | None = None, allow_deleted: bool = False
) -> Model

Get a model by SID.

Parameters:

Name	Type	Description	Default
sid	str	The SID of the model.
revision	int | None	Optional revision number.	None
allow_deleted	bool	Whether to allow retrieving deleted models.	False

Returns:

• Model: The requested Model.

create_empty_model

create_empty_model(
    name: str,
    *,
    folder: Folder | str | None = None,
    description: str | None = None,
    version: str | dict | None = None
) -> Model

Create an empty computational model with no content.

Parameters:

Name	Type	Description	Default
name	str	Name for the new model.
folder	Folder | str | None	Optional destination folder.	None
description	str | None	Optional description for the new project item.	None
version	str | dict | None	Optional version name str. Can also be a dict with the keys name and description to set a version description.	None

Returns:

• Model: The created Model.

create_model_from_json

create_model_from_json(
    *,
    json_content: dict[str, Any] | bytes | str | None = None,
    json_file_path: str | Path | None = None,
    name: str | None = None,
    folder: Folder | str | None = None,
    description: str | None = None,
    version: str | dict | None = None
) -> Model

Create a computational model from a raw JSON payload.

Exactly one of json_content or json_file_path must be provided.

Parameters:

Name	Type	Description	Default
json_content	dict[str, Any] | bytes | str | None	The model payload as a dict, JSON bytes, or JSON string.	None
json_file_path	str | Path | None	Path to a JSON file containing the model payload.	None
name	str | None	Optional name for the new project item.	None
folder	Folder | str | None	Optional destination folder.	None
description	str | None	Optional description for the new project item.	None
version	str | dict | None	Optional version name str. Can also be a dict with the keys name and description to set a version description.	None

Returns:

• Model: The created Model.