Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.speckle.systems/llms.txt

Use this file to discover all available pages before exploring further.

​
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, Settings and at the foot of the General Settings, and clicking the Delete project button.On the Enterprise plan, you can archive inactive work instead of deleting it. See Archive and unarchive projects.
Deleting a project is destructive. It will delete all the data associated with it.
Yes, on the Enterprise plan. Archiving removes the project from active lists without deleting its models and versions, and you can restore it later when needed. See Archive and unarchive projects.
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.
Important: All personal projects will be permanently deleted on January 1, 2026. If you have personal projects, migrate them to a workspace before this deadline.
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.
To make a project public, you need to change its visibility settings. Visibility is controlled at the project level, which means all models within the project will inherit the same visibility setting.To make your project public:
  1. Navigate to your project in the Speckle web application
  2. Open the project settings (usually accessible via a settings icon or gear menu)
  3. Find the Visibility or Access Control section
  4. Change the visibility setting from Private or Workspace to Public
  5. Save your changes
Once set to Public, anyone with the project link will be able to view and download all project data, even without a Speckle account. This includes:
  • Viewing the project in the web interface
  • Accessing all model data via the Speckle API
  • Downloading data using SDKs (like specklepy) or connectors (like Rhino/Grasshopper)
  • Retrieving all properties, metadata, and geometry
Important: Public projects are truly public data. Anyone with the link can programmatically download and retrieve all model data, properties, and metadata without authentication. This is by design and cannot be restricted. If you need to share only 3D visualization while protecting underlying data, consider creating a separate project with only display geometry (stripped of properties and metadata) before making it public.
Yes. Public projects are accessible without authentication, which means anyone with the project link can:
  • View the project in the web interface
  • Download all model data using the Speckle API
  • Access data programmatically using SDKs (Python, .NET, TypeScript) or connectors (Rhino, Grasshopper, Revit, etc.)
  • Retrieve all properties, metadata, and geometry information
This is by design—public projects are truly public data. There is no way to restrict programmatic access while keeping a project public. The Speckle API and all connectors can access public project data without requiring authentication tokens.If you need to share 3D visualization on a website while protecting your underlying model data, consider:
  • Creating a separate project containing only display geometry (stripped of properties and metadata)
  • Using a Private project with specific collaborators instead of making it public
  • Embedding a private project with token-based access, though note that embed tokens can still be used to access project data via the API
If you embed a public Speckle model on a website, anyone can extract the project URL and download the complete model data using Speckle tools or the API. Make sure you’re comfortable with all project data being publicly accessible before making a project public.

​
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.
Members are workspace users who are part of your core team. They can access all workspace projects by default (unless a project is set to Private), can create new projects, and are subject to workspace security policies like domain protection and SSO.Guests are external collaborators who only need access to specific projects. They can only access projects they’re explicitly invited to, cannot create new projects, and can join the workspace without adhering to domain policies or SSO requirements. This makes Guests ideal for subcontractors, consultants, or clients who need limited access.Both Members and Guests count toward your workspace’s user limit. The distinction is about access scope and security policies, not billing.
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.
Admins can remove users from the workspace from Workspace Settings -> People. Removing a user from the workspace also removes their access to all projects in that workspace, whether they were a Member or Guest.
Yes, both Members and Guests count toward your workspace’s user limit. The limit applies to the total number of users who have access to your workspace, regardless of whether they’re internal team members (Members) or external collaborators (Guests). If you need more users than your plan allows, contact us to discuss upgrading to Enterprise, which supports unlimited users.
Use the Guest role when you need to give someone access to only specific projects, such as:
  • External consultants or subcontractors who only work on certain projects
  • Clients who need to review specific work
  • Partners who collaborate on select projects
Use the Member role for your core team who need access to multiple or all workspace projects and should be subject to your workspace’s security policies.
You can only log in if you still have access to an email address that is on that account (e.g. a work or educational address). If you have both a personal and a work email on the account, you may still get in with the one you still use. Access to data in a workspace is always in accordance with the permissions set by the workspace organisation (e.g. whether they have kept you as a member). If you no longer have any of those emails, you cannot log in or recover that account; create a new account with a current, supported email. Workspaces belong to the organisation; if you need access to data and no longer have it, contact your prior employer.

​
Project roles

You can add anyone to a project role if this is allowed by workspace security settings. If a user is added to a project with the Contributor role, they are granted contributor-level project permissions. If they are not already a workspace member, they are added as a Guest.
No, roles are set on a member by member basis.

​
Billing and Usage

​
Users and Plans

You can upgrade your workspace to a paid plan from Settings -> Billing. Contact us at [email protected] if you need help choosing the right plan for your needs.
Workspace admins and project owners can change project roles. Changing a user from Contributor to Reviewer removes publish/load capability, but the user remains in the project and workspace. This does not affect billing. Plans are based on total users, not project role.
Yes, workspace admins can remove users from Settings -> People. Removing a user does not immediately free up a user slot if you’re at your plan’s limit—the user count adjusts when you add new users or upgrade your plan.

​
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/helpAnd 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]
Speckle Manager has been deprecated and is no longer required to install connectors. It can still be downloaded and used with legacy connectors.
Connectors are currently available for Windows only.
You can always reach us by posting on our Community Forum: https://speckle.community. We 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
  • Paid plan support
    • Paid plans include priority support.
Last modified on May 4, 2026