Latest news
TutorialsRevitOMARevit Automation API

Processing Projects with Linked Models Using the Revit Automation API

This guide explains how to determine whether Revit Cloud Worksharing projects are downloaded as a ZIP or a single RVT file, and how to pass linked models into an Automation API workflow.

Cloud-based BIM workflow represented by linked building massesAI image
Representative image, generated with AI.Image: 3dsınıfı / FCA AI

In brief

  1. Check the `isCompositeDesign` field to see whether a Revit Cloud Worksharing model contains a composite design.
  2. If `isCompositeDesign` is true, the download may be a ZIP package containing the host model and linked RVT files.
  3. For files published on or after 7 February 2025, you can use the GET linked Revit files call to retrieve linked models.
  4. In the older workflow, set `zip: true` for the ZIP input and use `pathInZip` to specify the name of the host model inside the ZIP.

What will you learn in this guide?

We’ll walk through why a file published through Revit Cloud Worksharing is sometimes downloaded as a ZIP instead of a single RVT, and how to pass that design into an Automation API workflow. The key distinction is whether the model is a composite design: linked RVT models may be packaged alongside the host file. So when preparing an automation task, checking the file extension alone isn’t enough—you also need to review the information in the API response for that file version.

The guide follows the API fields and two separate workflows described in the Autodesk Platform Services documentation. The cutoff date between the older and newer methods is 7 February 2025. The aim here isn’t to cover every authentication and application setup step for API calls, but to help you interpret the model information you have and choose the right input format.

Requirements

  • Have access to a Revit Cloud Worksharing project and Autodesk Platform Services APIs that let you read file information. The examples in the sources use API calls to inspect project and file-version details.

  • For Automation API use, take into account the active Forge trial or subscription requirements mentioned in the sources. The relevant source links to a separate page for pricing details; no current price is given here.

  • Be able to check the publication date of the model and the attributes.extension and attributes.data fields in the file-version response.

  • Don’t assume that a Revit desktop installation is required for this workflow: Autodesk’s explanation of the Revit Automation API describes access to the Revit database API without installing desktop Revit. This does not mean that API access or the required project inputs are unnecessary.

The sources do not provide a specific Revit version number, current subscription price, or a complete authentication setup, so none of that information is assumed here.

Step by step: identify the design and prepare the task

  1. Confirm that the file represents a Revit Cloud Worksharing model. In the response to API calls for project contents, file items, or versions, inspect the attributes.extension.type field. If its value is versions:autodesk.bim360:C4RModel, the source identifies the file as a Revit Cloud Worksharing model. This is the first step to interpreting the composite-design information in the right context.

  2. Read the composite-design flag. Find the attributes.data.isCompositeDesign field in the same version response. If its value is true, the model is marked as a composite design; the download may be a ZIP package containing the host model and linked RVT files. If the value is false, the source says that a single RVT file is returned when the latest versions of the host and linked files have been published.

  3. Identify the host model’s name. For a composite design, the attributes.data.compositeParentFile field gives the name of the host Revit file. This value is used in the older workflow, especially when you need to select the host model inside the ZIP. Treat the field’s value as the file name; don’t substitute your own guess for the value returned by the API.

  4. Check the publication date against the 7 February 2025 cutoff. The source describes the older method for models published before this date and the newer method for those published on or after it. Use the file’s attributes.createTime value to make the decision. Applying the same input format to every model without checking its date may cause the file expected by the work item to differ from the actual input.

  5. Set up the ZIP input for the older workflow. If the file was published before 7 February 2025 and contains a composite design, set zip to true in the work item’s inputFile settings. Set pathInZip to the host file name in compositeParentFile. This tells the task to use the ZIP package as input and specifies which RVT file inside it to process. The source demonstrates this method with an example DXF export task; apply the same logic according to the input requirements of the activity you choose.

  6. Retrieve the host and linked files together in the newer workflow. For files published on or after 7 February 2025, the GET linked Revit files call can return the host model and linked RVT files that have not been published. Check the host file and the linkedFiles results in the response, and review model names, version information, and publication status. Then pass the signed URLs returned by the call into the work item’s inputs. The source’s example shows a Published status for the host and NotPublished for the linked file; these statuses help explain why the host and linked file may not share the same publication status.

  7. Validate the input structure before running the task. The older method uses the ZIP and the host name inside it; the newer method uses the host and linked-file addresses in the GET linked Revit files response. Don’t mix these two approaches as if they were a single structure. Check that the files returned by the API match the inputs expected by the work item’s activity.

Common mistakes

Interpreting a ZIP download as a sign that the file is corrupted can be misleading when there are linked models that haven’t been published. First inspect the isCompositeDesign field and the host name. Another mistake is setting zip: true for every file without checking isCompositeDesign; for a non-composite model, this setting may not match the expected single-RVT input.

Don’t overlook the publication date either. According to the source, files from before 7 February 2025 use the older method, while files published on or after the cutoff date use the GET linked Revit files approach. Finally, don’t replace the value of compositeParentFile with a random file name, and don’t retrieve only the host model while omitting linked files when using the newer method.

Impact on architecture and visualization workflows

This distinction matters to teams that automatically export, review, or report on Revit data in the cloud. Not all linked models in a project may have been published at the same time, so an automation expecting a single RVT may process incomplete data if it doesn’t handle composite inputs correctly. Checking model information in advance helps ensure that the automation processes the right set of files.

For architecture firms and BIM teams, the main considerations are API access, subscription requirements, and correctly configuring the file inputs—not hardware. Visualization teams can also use this workflow for repetitive tasks such as exports or model analysis; however, the sources provide no information about compatibility with specific rendering software, processing times, or costs. It’s worth running a small validation test with the activity and file structure you plan to use before moving to production.

Next steps

Autodesk’s Revit API developer resources list getting-started guides, code samples, and community support. First, verify the model type, composite-design flag, and host name in the file-version response. Then choose the method that matches the publication date and test the work item’s input. As you expand the workflow, consider use cases mentioned in the sources, such as extracting and modifying Revit data, automated reporting, and documentation generation.

Sources and license

This guide is based on the Autodesk Platform Services Revit API overview, the Automation API announcement, and the guide to processing composite Revit designs. All three sources are openly accessible (license=free); their content has been adapted into Turkish.

Sources

3 sources
A
aps.autodesk.comaps.autodesk.com/developer/overview/revit
Summary
A
aps.autodesk.comaps.autodesk.com/blog/design-automation-api-revit-inventor-3ds-max-now-available
Summary
A
aps.autodesk.comaps.autodesk.com/blog/make-composite-revit-design-work-revit-automation-api
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 offices in Turkey, the most practical benefit of this approach is that it helps identify unexpected ZIP inputs caused by the publication status of linked models before automation begins. For teams that regularly export or analyze models, choosing the right input format could reduce retries and the need to sort through files manually.

When making an investment decision, API access, subscription requirements, and compatibility with existing workflows should take priority over powerful hardware. Since the sources don’t provide current pricing or processing costs, offices should assess their own use cases with a small test. This is also a useful example for students learning how linked Revit models are passed into cloud automation, but compatibility with specific software versions should be verified separately.

Frequently asked questions

How can you tell whether a file is a composite design in the Revit Automation API?

Check the file version’s `attributes.data.isCompositeDesign` field. If its value is `true`, the design is marked as composite, and the download may be a ZIP containing the host and linked RVT files.

Which method is used to pass linked Revit models to the Automation API?

For files published on or after 7 February 2025, the GET linked Revit files call can provide the host and linked files. The signed URLs in the response are passed to the work item’s inputs.

Is a Revit desktop installation required for the Revit Automation API?

According to Autodesk’s explanation of the Revit Automation API, the Revit database API can be accessed without installing desktop Revit. The sources separately specify API access and subscription requirements.

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

Related news