Getting Started with the Revit 2009 API

Here is a succinct overview of some resources available for getting started using the Revit API, compiled by Mikako Harada. The individual items have been mentioned in previous posts, and links to those are included. This document provides a useful and up-to-date overview for the current state, still focused on Revit 2009. You can expect an update of this material later in a couple of month's time, when the training material has been enhanced for Revit 2010.

1. Setting up the Environment
2. Where to Start
3. For more information
4. Looking forward for Revit 2010

1. Setting up the Environment

Revit Product – you can download the latest version of the released products from the Autodesk product page > Products > Alphabetically. From each Revit product page, look under Product Download. Here are the current links, but note that the exact locations may change:

• Revit Architecture
• Revit MEP
• Revit Structure

Without an activation code, you can only use Revit in view-only mode.

Revit SDK – the Revit SDK is included in every Revit install.

• DVD version: \Utilities\Common\Software Development Kit\Revit 2009 SDK.zip
• Web version: \Download\Utilities\Common\Software Development Kit\Revit 2009 SDK.zip

RevitAPI.dll is part of every Revit installation and is located in the folder \Program.

Development Environment – Microsoft Visual Studio 2005 for Revit 2009, and Visual Studio 2008 + SP1 for Revit 2010. The Express edition can also be used.

Revit API Documentation – The Revit SDK includes a Developer Guide, help file, and many samples. More detailed information on the SDK contents and how to manage, build and load the samples was discussed in some early blog posts:

• Getting Started with the Revit API
• The Revit SDK Contents
• Managing SDK Samples
• The SDK Samples Solution SDKSamples2009.sln
• Loading SDK Samples
• Debugging a Revit Add-In

Yet more information for beginners is included in the Getting Started category.

2. Where to Start

a. Watch the training video - The best way to start will be to watch our webcast material. This includes a recording of the webcast, the Powerpoint presentation, and training labs source code. This material is also available from the Developer Center training schedule page. There is a Revit Architecture and Revit Structure section in the Developer Center which provides other material including a polished version of the recording called DevTV, which is available for download or online viewing. It is slightly out of date, being based on Revit 2008. But you can still get the basic idea. You may want to see which one is suited for you.

b. Try running the HelloRevit sample yourself, go through the Labs code, and then look at some further samples in the SDK. The following samples provide good starting points:

• RevitCommands
• Fire Rating
• Viewers/ElementViewer
• CreateBeamsColumnsBraces

c. A must-have tool is RvtMgdDbg, which we discussed in a separate post.

3. For more information

• Autodesk University: search for 'Revit' in the Developer or Customization tracks. Here are a few classes held by us at last year’s AU with material providing additional information:
  • DE101-3 The Revit SDK Sample Smörgåsbord
  • DE111-3 A Closer Look at the Revit Database with the Revit API
  • DE205-3 Enhancing Your Revit Add-In
  You should be able to sign up and have access to this material.
• Autodesk Discussion Groups > Revit Architecture > Revit API.
• Autodesk Developer Network, the ADN web site, accessible to ADN members only, where you can:
  • Search DevNotes, which are Q & A pages.
  • Submit questions through DevHelp Online.

4. Looking forward to Revit 2010

We will be migrating and updating our training material for the Revit 2010 API in the coming months. The first intermediate result will be the webcast training on April 29^th. If you are interested in learning more about what is coming for Revit 2010, please take a look at the recording of the recent Developer Days Online AEC webcast.