Overview
TheModelResource provides methods for managing models within Speckle projects. Access it via client.model after authenticating your SpeckleClient.
Models are containers within projects that organize related versions of your data. Each model can have multiple versions representing different iterations or states.
Methods
get()
Get a single model by ID.get_models()
Get all models in a project with pagination support.Filter criteria. See ProjectModelsFilter
The
ResourceCollection object includes: - items - List of Model objects - totalCount - Total
number of models (across all pages) - cursor - Pagination cursor for next page (or None if no
more pages)get_with_versions()
Get a model with its versions included.Filter criteria for versions. See ModelVersionsFilter
create()
Create a new model in a project.Model creation parameters. See CreateModelInput
update()
Update an existing model’s properties.Model update parameters. See UpdateModelInput
delete()
Delete a model permanently.Model deletion parameters. See DeleteModelInput
projectId(str, required) - The project IDmodelId(str, required) - The model ID to delete
Types
Model
Represents a Speckle model within a project.User who created the model. See
LimitedUser
Input Types
CreateModelInput
create().
Fields:
name(str) - Model namedescription(str, optional) - Model descriptionproject_id(str) - Project ID
UpdateModelInput
update().
Fields:
id(str) - Model IDname(str, optional) - New model namedescription(str, optional) - New descriptionproject_id(str) - Project ID
DeleteModelInput
delete().
Fields:
id(str) - Model IDproject_id(str) - Project ID
Filters
ProjectModelsFilter
get_models() and client.project.get_with_models().
Fields:
contributors(List[str], optional) - Filter by contributor user IDsexclude_ids(List[str], optional) - Exclude specific model IDsids(List[str], optional) - Include only specific model IDsonly_with_versions(bool, optional) - Only return models with versionssearch(str, optional) - Search by model namesource_apps(List[str], optional) - Filter by source application
ModelVersionsFilter
get_with_versions().
Fields:
priority_ids(List[str]) - Version IDs to prioritizepriority_ids_only(bool, optional) - Only return priority versions
Related Resources
VersionResource
Create and manage versions in models
ProjectResource
Manage projects that contain models
Operations
Send and receive data to/from models
SpeckleClient
Main client documentation