Back to Main Site
Getting Started

Getting Started

Learn how to install and connect the Revit AI Suite to execute your first dynamic script.

Welcome to the Revit AI Suite documentation!

Revit AI Suite is a development toolchain designed to bridge Autodesk Revit with modern web technologies and AI models. It allows you to build custom, server-driven user interfaces (using React) and compile/run C# code on-the-fly inside Revit without needing to restart the application or build static DLLs.

How It Works

The Revit AI Suite consists of three core components:

  1. Revit Add-in: A desktop extension built on WebView2 that runs inside Autodesk Revit. It handles JSON-RPC communications, transpiles JSON UI structures into native WPF layouts, and interacts directly with the Revit API.
  2. Developer Dashboard: A web-based canvas (AetherUI) where you can write Roslyn-compatible C# scripts and inspect execution logs.
  3. Backend Server: A lightweight communication bridge that handles real-time WebSockets synchronization between the web editor and the active Revit session.

1. Quick Installation

To get started, follow these steps to install the Revit add-in:

  1. Navigate to the Downloads Page.
  2. Download the latest installer package: RevitAISuiteSetup.msi.
  3. Double-click the installer and follow the instructions.
  4. Open Autodesk Revit. When prompted with the security warning for the signature, select Always Load.

Once loaded, you will see a new Revit AI Suite tab on the Revit ribbon menu.

2. Connecting to the Portal

  1. Click the Open Panel button in the Revit ribbon menu to open the dockable WebView2 canvas on the right side of the Revit window.
  2. Open your browser to the Developer Dashboard and locate your authorization Access Code.
  3. Enter the access code inside the Revit panel inputs.
  4. Once authorized, the connection status indicator will turn green: ONLINE.

3. Your First Dynamic Execution

Now that your add-in is linked, you can execute a script:

  1. Go to the Developer Dashboard.
  2. Write a simple C# automation block:
    using Autodesk.Revit.DB;

// Renders a message box inside Revit
System.Windows.MessageBox.Show("Hello Revit AI Suite!");
  3. Click Compile & Run.
  4. Look at the Revit viewport to see the message box trigger instantly!