Overview
TheProjectResource provides methods for managing Speckle projects. Access it via client.project after authenticating your SpeckleClient.
Projects are the top-level containers in Speckle that hold models, versions, and team members.
Methods
get()
Get a single project by ID.get_permissions()
Get permission checks for a project.get_with_models()
Get a project with its models included.Filter criteria for models. See ProjectModelsFilter
get_with_team()
Get a project with its team members and pending invitations.create_in_workspace()
Create a new workspace project.Workspace project creation parameters. See
WorkspaceProjectCreateInput
update()
Update an existing project.Project update parameters. See ProjectUpdateInput
delete()
Delete a project permanently.update_role()
Update a team member’s role in the project.projectId(str, required) - The project IDuserId(str, required) - The user ID whose role to updaterole(str, required) - New role:"stream:owner","stream:contributor", or"stream:reviewer"
stream:owner- Full control, can delete project and manage teamstream:contributor- Can create models and versionsstream:reviewer- Read-only access
Types
Project
Represents a Speckle project.PermissionCheckResult
Result of a permission check operation.Input Types
ProjectUpdateInput
update().
Fields:
id(str) - Project IDname(str, optional) - New project namedescription(str, optional) - New descriptionallow_public_comments(bool, optional) - Allow public commentsvisibility(str, optional) - New visibility setting
WorkspaceProjectCreateInput
create_in_workspace().
Fields:
name(str) - Project namedescription(str, optional) - Project descriptionvisibility(str, optional) -"PRIVATE","PUBLIC", or"UNLISTED"workspaceId(str) - Workspace ID
Filters
ProjectModelsFilter
get_with_models() and client.model.get_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
Related Resources
ModelResource
Work with models in projects
VersionResource
Manage versions in models
ActiveUserResource
Get user’s projects and permissions
SpeckleClient
Main client documentation