Overview
TheVersionResource provides methods for managing versions within Speckle models. Access it via client.version after authenticating your SpeckleClient.
Versions represent specific states or iterations of your data within a model. Each version references a committed object and includes metadata like author, timestamp, and a descriptive message.
Methods
get()
Get a single version by ID.get_versions()
Get all versions in a model with pagination support.The
ResourceCollection object includes: - items - List of Version objects - totalCount -
Total number of versions (across all pages) - cursor - Pagination cursor for next page (or
None if no more pages)create()
Create a new version pointing at an object sent withoperations.send. This publish path is deprecated, and Speckle does not guarantee it for new work: publish with operations.send3, which creates the version for you.
The returned version id is reserved: the version appears in queries only when the server finishes
processing — see Publish through model
ingestions.
Version creation parameters. See CreateVersionInput
project_id(str, required) - The project IDmodel_id(str, required) - The model IDobject_id(str, required) - The ID of the object to reference (fromoperations.send())message(str, optional) - Commit message describing this versionsource_application(str, optional) - Name of the source application
update()
Update an existing version’s properties.Version update parameters. See UpdateVersionInput
You can only update the message of a version. The referenced object cannot be changed after
creation.
move_to_model()
Move versions from one model to another within the same project.Move parameters. See MoveVersionsInput
project_id(str, required) - The project IDversion_ids(List[str], required) - List of version IDs to movetarget_model_id(str, required) - The destination model ID
delete()
Delete one or more versions permanently.Deletion parameters. See DeleteVersionsInput
project_id(str, required) - The project IDversion_ids(List[str], required) - List of version IDs to delete
received()
Mark a version as received (useful for tracking which versions have been processed).project_id(str, required) - The project IDversion_id(str, required) - The version ID to markmessage(str, optional) - Optional messagesource_application(str, optional) - Application that received the version
This method is useful for automation workflows where you want to track which versions have been
processed by your scripts or applications.
operations.receive3 marks the version as received for
you unless you pass mark_received=False.Types
Version
Represents a version within a Speckle model.For a version published before 2026.9, the ID of the committed root object. For a 2026.9 version,
a bundle reference (
bundle.<projectId>.<modelId>.<versionId>): load it with
operations.receive3 and the version’s ids instead.User who created the version. See
LimitedUser
Input Types
CreateVersionInput
create().
Fields:
object_id(str) - ID of the object (fromoperations.send())model_id(str) - Model IDproject_id(str) - Project IDmessage(str, optional) - Version message/descriptionsource_application(str, optional) - Source application name. Default:"py"total_children_count(int, optional) - Total number of child objectsparents(List[str], optional) - Parent version IDs
UpdateVersionInput
update().
Fields:
version_id(str) - Version IDproject_id(str) - Project IDmessage(str, optional) - New version message
DeleteVersionsInput
delete().
Fields:
version_ids(List[str]) - List of version IDs to deleteproject_id(str) - Project ID
MoveVersionsInput
target_model_name(str) - Name of the target modelversion_ids(List[str]) - Version IDs to moveproject_id(str) - Project ID
Related Resources
Operations
Send and receive objects for versions
ModelResource
Manage models that contain versions
ServerTransport
Transport for sending/receiving data
SpeckleClient
Main client documentation