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.

Speckle currently supports versions: . The connector works on only.
2022 support has ended. If you use AutoCAD 2022, use connector version 3.21.0 or upgrade AutoCAD to a supported version. For more context, see this forum post.

​
Setup

1

Install the connector

Install your connector
2

Open the AutoCAD connector

  1. In AutoCAD, select the Speckle tab in the ribbon.
AutoCAD toolbar
  1. Select Speckle to open the AutoCAD 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 types of Geometry can be published, as well as Hatch, Text, and Blocks. Each published object contains the following information:
  • Color
  • Render material
  • Extended Data and Extension Dictionaries
All custom properties can be found under the properties field when you select and view an AutoCAD object in your browser. Custom properties include:
  • extension dictionary
  • extended data
Solids will only be published as Mesh geometry.
New model creation defaults to your current file name, so you do not need to manually remove full path-like names before publishing. You can still rename the model before sending.
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
Image texture files are not supported. Speckle does not transfer bitmaps or other image maps (such as JPG or PNG files) embedded in materials from the source application.Speckle does carry PBR-style material data in general—where a connector maps to it, materials can include properties such as base colour, opacity, metalness, roughness, and emissive colour. That is not the same as shipping texture images: you get numeric material parameters, not image assets used for wood grain, brick patterns, and similar in the authoring tool.Different materials can still appear separately in the destination with distinct colours and PBR fields. What you see may look closer to a consistent shaded or PBR preview than to the full render-appearance with image maps in tools such as Revit or SketchUp. To use image textures in your target application, apply or remap them locally after you publish or load.
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 geometry, text, or blocks in AutoCAD. They will be created in a flattened layer structure as what you see when viewing your model in your browser. Each object will be loaded with:
  • Render material (if any)
  • Color (if any)
Speckle models are loaded into their own Selection Set. You can use this to easily select all layers created by your loaded model.
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 .
Image texture files are not supported. Speckle does not transfer bitmaps or other image maps (such as JPG or PNG files) embedded in materials from the source application.Speckle does carry PBR-style material data in general—where a connector maps to it, materials can include properties such as base colour, opacity, metalness, roughness, and emissive colour. That is not the same as shipping texture images: you get numeric material parameters, not image assets used for wood grain, brick patterns, and similar in the authoring tool.Different materials can still appear separately in the destination with distinct colours and PBR fields. What you see may look closer to a consistent shaded or PBR preview than to the full render-appearance with image maps in tools such as Revit or SketchUp. To use image textures in your target application, apply or remap them locally after you publish or load.
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.
Last modified on June 3, 2026