Skip to main content
Speckle currently supports versions: . The connector works on only.

​
Setup

1

Install the connector

Install your connector
2

Open the Revit connector

  1. In Revit, select the Speckle tab in the ribbon.
Revit toolbar
  1. Select Speckle to open the Revit connector.
  1. Select Sign in if you haven’t linked your Speckle account.
Login
  1. Make sure your version of is one of the supported versions.
  2. Uninstall and reinstall your connector.
Note: Make sure you are not selecting Run as administrator when installing - this will install for the administrator user, and not your own user. Instead, double-click the .exe or right-clicking and then selecting Open to run the installer. Installation issues can also be caused by conflicting plugins.If you’re still experiencing problems, please report it in our Community Forum and include the following information:
  • Your application version
  • Your Speckle connector version
If your connector window is floating, try docking it to your application to fix blank UI issues.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 and include the following information:
  • Your application version
  • Your Speckle connector version
  • A copy of the log
This can happen if our desktop service isn’t running. Desktop Service is used for authenticating new accounts. If it’s not running, search for Speckle Desktop Services in Windows search and run it.
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 in the web app. If a new version of the connector is available, you will also see a notification in your connector UI.

​
Publishing a Model

1

Select Publish

Publish
2

Choose a project

  • Select an existing project
  • or select New Project to create one
Publish
3

Choose a model

  • Select an existing model
  • or select New Model to create one
Publish
4

Select objects to publish

  1. In your application viewport, select the elements you want to publish.
  2. Select Publish.
Publish
Publish
  1. Your model is now published to Speckle and is available to the rest of your team.
All visible elements in the Model category (such as walls, floors, beams, and columns) can be published. In the Annotation category, only visible gridlines can be published. Each element contains the following information:
  • category, family, and type
  • level
  • location curve (if any)
  • Mesh (solid elements), Curve (model curves), or Pointcloud geometry
  • custom properties
  • render material
  1. Click the blue filter field at the top of Select objects dialog while publishing a new version.
Revit filters
  1. Select Views, and then select the view you would like to publish from.
  1. Click the blue filter field at the top of Select objects dialog while publishing a new version.
Revit filters
  1. Select Categories, and then click on any number of categories you would like to add to the filter.
Linked models are supported by default when publishing. If they are not included in your published version:
  1. Expand the Settings field at the bottom of the Select objects dialog while publishing a new version.
Revit settings
  1. Check that the Include linked models toggle is turned on.
If you are using reference points to coordinate your project, you can publish your Revit model according to a specific reference point:
  1. Expand the Settings field at the bottom of the Select objects dialog while publishing a new version.
Revit settings
  1. Set the Reference Point setting to your desired reference point. Your published model will now be oriented according to your specified reference point.
All custom properties can be found under the properties field when you select and view a Revit object in your browser. Custom properties vary depending on the type of Revit element, and can include:
  • element id, built-in category, and workset properties
  • material quantities
  • parameters
  • structural material properties (such as density and compressive strength)
  1. Expand the Settings field at the bottom of the Select objects dialog while publishing a new version.
Revit settings
  1. Toggle the Send Rebars As Volumetric setting to true. Caution: publishing all rebars as their volumetric representations can significantly slow down publishing speed.
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
After you publish 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.

​
Loading a Model

1

Select Load

Load
2

Choose a project

Load
3

Choose a model

Load
4

Choose a version to load

  • Latest version is always first.
  • To load a specific version, select it from the UI.
Load
Load
Your selected model is now loaded in .
All objects in Speckle models are loaded as Direct Shapes (generic models) with a default category in Revit. If your model contains block instances, each instance will be loaded as its own generic model. Each object will be loaded with:
  • render material (if any)
  • Mesh, Curve, or Solid (only from Rhino and Grasshopper) geometry.
Currently, you can not load any custom properties on your Speckle model objects into Revit.
If you are using reference points to coordinate your project, you can load your Revit model according to a specific reference point:
  1. Expand the Settings field at the bottom of the Select objects dialog while publishing a new version.
Revit settings
  1. Set the Reference Point setting to source if you want to load your model according to the incoming model coordinate system.
  2. Set the Reference Point setting to InternalOrigin if you want to load your model according to your current document’s internal origin.
  3. Set the Reference Point setting to ProjectBase if you want to load your model according to your current document’s project base point.
  4. Set the Reference Point setting to Survey if you want to load your model according to your current document’s survey point.
If your Speckle model was published from Rhino or Grasshopper, it will contain solid geometry and you can edit the material of the created direct shape as you’d like. For any other Speckle model, currently it is not possible to change the applied material.
Currently, you can not change the category of a loaded object.
After you 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 loading in .
This happens when you don’t have permissions to load a project. Contact the project owner to change your role.
Yes. Next to the search box in the project selection dialog, there’s an Add model by URL option. Paste the model URL there.
⌘I