Latest news
Snapchat Announces Easy Lens CLI, Bringing AR Lens Creation to AI AssistantsBIG’s Timber Project in Thun Covers Four Buildings and 13,000 Square MetersAMD HPC Assistant Announced: Open-Source AI Support for SupercomputersBlender Eevee Ray Tracing Settings: An Interior Lighting GuideSupermicro Petascale Server Launches with PCIe 6 and AMD EPYC 9006Place des Montréalaises: A Public Space Above a Highway in MontrealGenie 4 is now available: Project Genie edits worlds in real timeRhino 8 Make2D and Print guide: prepare and print technical drawingsAmsterdam Opens Design Competition for OBA Next-Led Kraaiennest HubRevopoint MIRACO 2 on Kickstarter: Six Scan Modes and Planned Scan-to-CAD
Tips & GuidesRevitAutodeskOMA

How to Run a Revit Plugin in the Cloud with APS Design Automation

Autodesk’s APS Design Automation API v3 documentation explains how to run Revit plugins on the Automation Service. This guide covers removing UI dependencies and following requests with Postman or cURL.

Architecture office and building model suggesting a cloud-based Revit workflowAI image
Representative image, generated with AI.Image: 3dsınıfı / FCA AI

In brief

  1. APS Automation Service provides access to a headless version of Revit.
  2. Plugins intended to run in the cloud must have references to the user interface removed.
  3. The preparation step requires changes to C# code; those without C# experience can start from Task 2 using the ready-made DeleteWalls.dll.
  4. HTTP requests can be sent with cURL or a Postman collection, following the official walkthrough.

Autodesk’s APS Design Automation API v3 documentation provides a step-by-step walkthrough for developers who want to run Revit plugins on the Automation Service. It focuses on preparing an existing plugin to run in the cloud and following the required HTTP requests with Postman or cURL. APS provides a headless version of Revit in the cloud and access to the Revit DB API. This makes it possible to create, inspect, and modify model data without installing Revit on a desktop.

Define the scope before you begin

  1. Identify the task to automate. Autodesk says the Automation API can be used to build cloud applications that create, extract, and modify Revit data. The documentation gives examples such as creating custom Revit families, automating model setup, analyzing model data, preparing reports, modifying existing models to meet company standards, and creating documentation. First, determine which of these tasks the plugin will handle.

  2. Keep the walkthrough’s scope in mind. This document explains how to run an existing Revit plugin on the Automation Service, not how to build a plugin from scratch. For plugin development, it points to Autodesk’s Revit Developer Center as a separate resource. Treating development and cloud execution as separate stages makes it easier to interpret the walkthrough correctly.

  3. Don’t assume you can use the desktop interface. User interaction isn’t supported on the Automation Service. A plugin that communicates with the Revit interface must therefore be stripped of those dependencies before being moved to the cloud. If the plugin expects users to make selections or confirm actions, consider separately how those steps will be handled in an automated environment. The key preparation requirement explicitly stated in the official walkthrough is to remove interface references.

Prepare the Revit plugin for the Automation API

  1. Remove interface references. The walkthrough’s first task is to make the Revit plugin suitable for use with the Automation API. This involves changing the C# code and removing references to the user interface. Since the service doesn’t allow user interaction, leaving interface-dependent functionality in place can make the plugin’s behavior incompatible with the cloud environment.

  2. Choose a path based on your C# experience. Developers familiar with C# can follow the preparation steps in the walkthrough’s first task. This involves removing the parts of the existing plugin that are tied to the interface and adapting it to run in the cloud. The guide isn’t a general plugin-development tutorial, so it doesn’t add code samples or implementation details that aren’t in the documentation.

  3. Use the ready-made sample. Those without C# experience can download Autodesk’s DeleteWalls.dll, skip the first task, and continue from Task 2. This lets you follow the steps for running a plugin on the service with a sample file. However, having a ready-made DLL doesn’t mean another plugin will run without changes; each plugin’s interface dependencies must be assessed separately.

Send requests with Postman or cURL

  1. Follow the task sequence in the walkthrough. The guide explains the HTTP requests used to run a plugin on the Automation Service. If you prefer Postman, you can import the APS tutorial collection linked by Autodesk. Requests in the collection are grouped by task, and their names correspond to the steps in the walkthrough. Alternatively, you can send the same requests with cURL.

  2. Note that Task 1 isn’t in the collection. The plugin-preparation task is done in Visual Studio and doesn’t send an HTTP request to APS. As a result, the Postman collection doesn’t include a group for Task 1. Once the plugin is prepared, you can continue with the relevant tasks in the collection.

  3. Compare task and request names. Since the collection’s groups and requests use the same names as the steps in the walkthrough, you can track where each request fits in the process. First, confirm that plugin preparation is complete, then proceed in the order given in the documentation. This guide doesn’t add commands for authentication, file uploads, or run parameters that aren’t explained in the source walkthrough.

Implications for architecture and visualization workflows

Architecture and interior design firms looking to automate repetitive model tasks, standards checks, or report generation in Revit can consider running their plugins in the cloud. According to Autodesk, the Automation API provides access to workflows that create, extract, and modify model data through the Revit DB API. This may be useful for teams that want to separate repetitive tasks from desktop use. However, the source documentation provides no figures on processing time, capacity, cost, or performance.

Archviz teams can explore potential use cases involving model inspection and automated processing, but the walkthrough doesn’t explain compatibility with specific render engines or rendering settings. The ability to run a Revit plugin in the cloud shouldn’t therefore be interpreted as confirmation that a particular visualization tool is supported. The documentation also doesn’t specify local hardware requirements, licensing, or pricing. These points should be verified separately before implementation.

Common mistakes

  • Running a plugin with interface dependencies before preparing it: Since user interaction isn’t available on the Automation Service, interface references must be removed.

  • Treating the walkthrough as a plugin-development tutorial: The guide explains how to run an existing plugin in the cloud.

  • Looking for Task 1 in the Postman collection: This task is done in Visual Studio, so it isn’t included in the collection.

  • Assuming the sample DLL is a ready-made solution for every plugin: DeleteWalls.dll is provided as a starting example; other plugins must be prepared separately to ensure they’re suitable for the cloud.

The basic sequence in the APS Design Automation API v3 Revit walkthrough is to remove the plugin’s interface dependencies, prepare it with C# or start with the ready-made sample, and then follow the HTTP requests with Postman or cURL. Details on compatibility, cost, and performance that fall outside the walkthrough’s scope need to be verified separately.

Sources

2 sources
A
aps.autodesk.comaps.autodesk.com/en/docs/design-automation/v3/developers_guide/overview
Summary
A
aps.autodesk.comaps.autodesk.com/en/docs/design-automation/v3/developers_guide/revit
Summary

Source texts are not republished; short quotes are marked, everything else is our own summary and commentary.

3dsınıfı’s take
3dEditor’s assessment

For architecture and interior design firms in Turkey, the practical value of this approach is the ability to move repetitive Revit tasks into a cloud-based workflow. It can be considered for tasks such as model data analysis, standards checks, and reporting, but the plugin’s interface dependencies need to be removed first.

It’s important to research licensing and pricing separately before making a decision; the official documentation doesn’t explain costs, capacity, or hardware requirements. Render compatibility is also outside the walkthrough’s scope. Firms would be wise to test a limited workflow first and verify that the plugins they use are suitable for the cloud environment.

Frequently asked questions

Can a Revit plugin use the user interface on the APS Automation Service?

No. According to Autodesk’s walkthrough, user interaction isn’t available on the Automation Service. Interface references must be removed before running the plugin.

Is C# knowledge required to run a Revit plugin through APS?

The preparation task requires changes to C# code. Those without C# experience can start from Task 2 using Autodesk’s DeleteWalls.dll.

How is the Postman collection used in the APS Revit walkthrough?

The collection groups requests by task and matches their names to the steps in the walkthrough. Task 1 isn’t included because plugin preparation is done in Visual Studio.

Comments and the forum are in Turkish.Join the discussion
+

Related news