Getting Started on Forge

Creating a Forge App

The first step to using Design Automation for Revit is to create a Forge app. Please create a Forge app using instructions in the following link: https://developer.autodesk.com/en/docs/oauth/v2/tutorials/create-app/

Action Required: When you have successfully created the app, please email revit.io.support@autodesk.com the Client ID associated with your app so we can whitelist this app for the private beta. We do not require your app’s Client Secret.

Authentication

Please refer to the following links for more details: https://developer.autodesk.com/en/docs/oauth/v2/reference/http/authenticate-POST/ https://developer.autodesk.com/en/docs/oauth/v2/overview/field-guide/

You use the Client ID and Client Secret obtained above to authenticate your application and obtain a two-legged access token. The details of the HTTP response is given in the above link. Please learn about the access tokens and their validity.

Please use scope=code:all instead of scope=data:read to obtain a token. All Design Automation for Revit APIs require this scope.

sh curl -v 'https://developer.api.autodesk.com/authentication/v1/authenticate' -X 'POST' -H 'Content-Type: application/x-www-form-urlencoded' -d 'client_id=YourForgeAppClientID' -d 'client_secret=YourForgeAppClientSecret' -d 'grant_type=client_credentials' -d 'scope=code:all' The response body to this request contains the token that you shall use for all our APIs. The response also contains the expiration time of the token.

Forge API Errors

Some of the common errors returned by the APIs and their potential causes are listed here.