Quick Reference
Your Speckle Workspace
- Overview
- Organizing your Data
- Version Control
- Roles and Seats
- Inviting and Security
- Data Residency
- Billing
Viewing & Sharing
- Interface and Navigation
- Commenting and Reviewing
- Share your Models
Publishing & Loading
Developers
Frequently Asked Questions
We’ve collected commonly asked questions that you might have as you get started.
Projects, Models and Versions
Projects
The number of projects you can create is subject only to the limits of your workspace.
Yes, you can delete a project by selecting the project from the projects list page and clicking the Delete project button.
Deleting a project is destructive. It will delete all the data associated with it.
Yes, if you the project owner, you can rename a project by selecting the project from the projects list page and clicking the Rename project button.
No, not in the web interface, if this is something you need critically, contact us either in the application chat or by email at [email protected] A project made in the personal projects era can be migrated one time to a workspace.
No, it will not break anything. The only thing that will be affected is the name of the project.
No, you cannot enforce naming conventions to project names.
Yes, you can change the description of a project by selecting the project from the projects list page and clicking the Edit project button.
No, there is no limit to the number of members in a project. However, depending on your workspace plan you may be charged for additional project members not already in your workspace.
You can add as many viewers to your project as you like, they are free.
Models
No, edit rights are set at the project level only at this time.
No, read-only status is set at the project level only at this time.
Here are a few common reasons:
- Split by discipline: For large projects, separate models by team, e.g., Architecture, Structural, and MEP. This ensures each team receives only what’s relevant.
- Split by building: If your project includes multiple buildings, keep them in one project but create separate models like Building A, Building B, and Building C.
- Explore design options: Want to present different façade concepts? Create models like Option A, Option B, and Option C and switch between them to show your client.
In Speckle, you can federate models by loading multiple models into the same view — even if created separately. This is useful for working with different teams or disciplines. For example, view the architecture, structure, and MEP models together in a single, coordinated view without merging them into one file.
Federating models helps you:
- Compare design options
- Coordinate between disciplines
- Keep models separate while viewing them side by side You can do this directly in the Speckle 3D viewer or in supported design tools using our connectors.
You can create as many models as needed within a project. The Speckle Web App makes it simple to:
- Add new models
- Rename models
- Switch between models This helps you keep your work organised and ensures each model is used as intended.
You can delete a model by selecting the Delete model button in the model settings drop-down found on the models list page. This will remove the model from the project and all associated data.
You can have as many models as you need in a project. However, the number of models you have in total in your workspace across all projects may be limited by your workspace plan.
You can switch between models by selecting the model from the models list page. This will open the model in the Speckle Web Viewer.
Yes, you can rename a model by selecting the model from the models list page and clicking the Rename model button.
You can move a model to another folder by selecting the model from the models list
page and clicking the Rename model button.
It is the presence of /s in the model name that determines the folder structure.
You can have as many folders as you need in a project. It is the presence of /s in the
model name that determines the folder structure. However, it may be preferable to only use
one or two levels of folders to keep your models organised.
Theoretically no, but the performance of the 3D viewer will be impacted if it is large number of extremelly detailed objects. It can be benefical to break models up and federate them together as required to keep the performance high.
Versions
You can only set the version message, potentially to something meaningful like “Approved for release”.
Versions are stored indefinitely, but you may be limited as to how many you can see depending on your workspace plan.
No, once a version is published it is visible to all users with permission to view the model.
Only the owner of the model can delete versions.
You can publish as many versions as you want, but you may be limited as to how many you can see.
Yes, you can set or edit the version message for any version from the version history page.
All older versions are stored indefinitely but may be hidden if depending on your workspace plan limits.
You can compare two versions to see the differences between them. This is useful to review changes, or to see what changed between two specific points in time. You can do this in the 3D viewer, more details can be found in the compare versions page.
If you’ve published a version by mistake you can delete it. This will remove it from the model and if you delete the latest version it will make the previous version the latest.
You can’t promote a specific version to be the latest, but you can publish a new version which will become the latest. Or delete all newer versions. Receiving a specific version and re-publishing it will theoretically restore it, but this can be a lossy process depending on the connector. More reliable would be to do so programmatically.
You will prompted in your connector to set a version message when you publish.
Permissions and Roles
Workspace roles
A workspace role is a role that determines what actions a user can perform within a workspace.
Guest roles are a type of workspace role that allows users to view and comment on models in a workspace.
You can invite someone to your workspace by clicking the Invite button in the top right corner of the workspace page.
You can also set your workspace to allow self-signup by making your workspace domain discoverable. Users with an email domain matching what you have verified to the workspace will be notified your workspace exists and can request to join. You can also set it up to automatically add them to the workspace without admin approval.
Only admins can invite users to a workspace.
Learn more about inviting users to a workspace.
You can remove someone from your workspace by clicking the Remove button in the top right corner of the workspace page.
Project roles
You can add anyone to a project role if it is allowable by the workspace security settings. If a user is added to a project as member who can edit they will be added as an editor to the workspace. If they are not a member of the workspace they will be added as a guest.
No, roles are set on a member by member basis.
Billing and Usage
Seats
Yes, within a billing cycle if a seat is removed from a workspace member or guest then it can be allocated to another.
They will remain a project team member but their role will be downgraded to can view.
They will remain a workspace member but their role will be downgraded to can view. Their role on any projects they are a member of will also be downgraded to can view.
Troubleshooting
Connectors
Specific connector frequently asked questions can be found in each connector’s usage guide.
Revit
Usage guide for publishing and loading Revit models.
Rhino
Usage guide for publishing and loading Rhino models.
Grasshopper
Usage guide for publishing and loading Grasshopper models.
Power BI
Usage guide for loading models into Power BI.
Blender
Usage guide for loading models into Blender.
Civil 3D
Usage guide for publishing and loading Civil 3D models.
AutoCAD
Usage guide for publishing and loading AutoCAD models.
Archicad
Usage guide for publishing and loading Archicad models.
Tekla
Usage guide for publishing Tekla models.
ETABS
Usage guide for publishing ETABS models.
Navisworks
Usage guide for publishing Navisworks models.
SketchUp
Usage guide for publishing and loading SketchUp models.
General Connector Troubleshooting
Make sure your version of is one of the supported versions. Installation issues are also sometimes caused by conflicting plugins. Please report your problem in our Community Forum: https://speckle.community/c/help
And include the following information:
- Your application version
- Your Speckle connector version
If you still have the legacy version installed, make sure you have version 2.23 or above. Any version below 2.23 will have conflicting commands with the AutoCAD connector.
In the viewer, select the View Modes button in the side bar, and switch the view mode to Shaded. If you still don’t see your object colors, let us know in our Community Forum: https://speckle.community/c/help
After you publish or load a Speckle model, click on the Report button to see any errors that may have occurred. Click on any item in the report to highlight that item in your application. Some objects may not be supported for publishing or loading.
For major issues, you can sometimes find a log file in your directory at AppData\Roaming\Speckle\Logs. Please report your problem in our Community Forum: https://speckle.community/c/help And include the following information:
- Your application version
- Your Speckle connector version
- A copy of the log
All Speckle connectors are installed like any other program. You can uninstall them directly from your system’s Applications. For a full uninstall, you should also remove Speckle Desktop Services as well as your Speckle connector.
You can always download the latest version of the connector at https://app.speckle.systems/connectors. If a new version of the connector is available, you will also see a notification in your connector UI. [@bilal need autoupdating behavior]
You can always reach us by posting on our Community Forum: https://speckle.communityWe try our best to respond as quickly as possible!
How to Get Help
If you have any questions or issues not listed here, please contact us:
- In-app support
- Community support
- Report a bug
- Request a feature
- Ask a question
- Business plan support
- Some plans include priority support.