🌼 RAPS
Download

Which APS API Do I Need?

Interactive decision tree to help you choose the right Autodesk Platform Services API for your project

💡 Quick Start: Answer a few questions below to get personalized API recommendations with RAPS CLI commands.

Don't want to go through the questions? Jump to Common Use Case Scenarios instead.

🎯 Interactive API Selector

Need to display 3D models in a web browser?

Need to store/manage files in the cloud?

Working with BIM 360/ACC projects?

Need to convert file formats?

Need to automate CAD software operations?

🎯 3D Web Viewer Solution

You need to display 3D models in web browsers. Here's your tech stack:

• Viewer SDK - 3D model display in browser
• Model Derivative API - Convert files to web formats
• Object Storage Service - Store original files

RAPS Workflow:

raps auth login
raps oss upload model.rvt mybucket
raps translate $(raps urn encode "urn:adsk.objects:os.object:mybucket:model.rvt") --wait
raps view $(raps urn encode "urn:adsk.objects:os.object:mybucket:model.rvt")
Auth: 2-legged OAuth | Scopes: data:read, viewables:read, bucket:read

🏢 BIM 360/ACC File Management

You need access to BIM 360 or Autodesk Construction Cloud projects:

• Data Management API - Project files & folders
• Authentication API - User authorization (3-legged)

RAPS Workflow:

raps auth login --3legged --scopes account:read,data:read
raps dm projects
raps dm folders <project-id>
raps dm download <item-id> ./local-file.rvt
Auth: 3-legged OAuth (user must have project access) | Scopes: account:read, data:read

🗄️ Simple File Storage

You need basic cloud file storage for your application:

• Object Storage Service - Upload/download files

RAPS Workflow:

raps auth login
raps bucket create my-app-files
raps oss upload document.pdf my-app-files
raps oss download my-app-files document.pdf
Auth: 2-legged OAuth | Scopes: bucket:read, bucket:create

🔄 File Format Conversion

You need to convert CAD files to different formats:

• Model Derivative API - File format conversion
• Object Storage Service - Input/output storage

RAPS Workflow:

raps bucket create batch-processing
raps oss upload-batch *.dwg --bucket batch-processing
raps translate-batch --bucket batch-processing --formats pdf,svf2 --parallel 5
Auth: 2-legged OAuth | Scopes: bucket:read, bucket:create, data:read

🤖 CAD Automation

You need to automate CAD software operations in the cloud:

• Design Automation API - Cloud CAD engines
• Object Storage Service - Input/output files

RAPS Workflow:

raps da engines --filter autocad
raps da create-activity MyProcessor --engine Autodesk.AutoCAD+24
raps da submit-workitem MyProcessor --input drawing.dwg --script process.scr
Auth: 2-legged OAuth | Scopes: code:all, bucket:read, bucket:create

🔑 Authentication Only

You just need to authenticate and get access tokens:

• Authentication API - OAuth token management

RAPS Workflow:

raps auth login
raps auth status
raps auth refresh  # When token expires
Auth: 2-legged or 3-legged OAuth | Scopes: Depends on intended use

🌐 Common Use Case Scenarios

🌐 Web-Based 3D Model Viewer

"I want users to view 3D models in my web application"

APIs Needed:

  • • Model Derivative API → Convert files to web-viewable formats
  • • Viewer SDK → Display models in browser
  • • Object Storage Service → Store original files
# Manual: 5+ API calls, complex geometry handling
# With RAPS:
raps auth login
raps oss upload model.rvt mybucket
raps translate $(raps urn encode "urn:adsk.objects:os.object:mybucket:model.rvt") --wait
raps view $(raps urn encode "urn:adsk.objects:os.object:mybucket:model.rvt")
Auth: 2-legged OAuth (server apps) or 3-legged (user apps)
Scopes: data:read, viewables:read, bucket:read

📁 BIM 360/ACC File Management

"I need to access files from BIM 360 or Autodesk Construction Cloud projects"

APIs Needed:

  • • Data Management API → Access project files and folders
  • • Authentication API → User authorization (3-legged OAuth)
# Manual: Complex hub/project hierarchy navigation
# With RAPS:
raps auth login --3legged --scopes account:read,data:read
raps dm projects
raps dm folders <project-id>
raps dm download <item-id> ./local-file.rvt
Auth: 3-legged OAuth (user must have project access)
Scopes: account:read, data:read, data:write (if uploading)

🔄 Batch File Processing

"I need to convert hundreds of CAD files to different formats"

APIs Needed:

  • • Object Storage Service → Upload source files
  • • Model Derivative API → Batch translation jobs
  • • Webhooks (optional) → Get notified when complete
# Manual: Complex job queuing, polling, error handling
# With RAPS:
raps bucket create batch-processing
raps oss upload-batch *.dwg --bucket batch-processing
raps translate-batch --bucket batch-processing --formats pdf,svf2 --parallel 5
Auth: 2-legged OAuth
Scopes: bucket:create, bucket:read, data:read

🤖 CAD Automation & Scripting

"I want to automate repetitive tasks in AutoCAD/Revit/Inventor"

APIs Needed:

  • • Design Automation API → Cloud-hosted CAD engines
  • • Object Storage Service → Input/output file storage
# Manual: Complex AppBundle/Activity setup, WorkItem management  
# With RAPS:
raps da engines --filter autocad
raps da create-activity MyDrawingProcessor --engine Autodesk.AutoCAD+24
raps da submit-workitem MyDrawingProcessor --input drawing.dwg --script process.scr
Auth: 2-legged OAuth
Scopes: code:all, bucket:read, bucket:create

📊 API Comparison Matrix

Use Case Primary API RAPS Commands Auth Type
3D Web Viewer Model Derivative raps view, raps translate 2-legged or 3-legged
BIM 360 Files Data Management raps dm projects, raps dm download 3-legged only
Simple File Storage Object Storage raps oss upload, raps bucket create 2-legged
Format Conversion Model Derivative raps translate --formats 2-legged
CAD Automation Design Automation raps da submit-workitem 2-legged

🚀 Next Steps

Once You Know Your API:

  1. Set up authentication with required scopes
  2. Test basic connectivity
  3. Start with RAPS examples
  4. Review detailed documentation

Still Not Sure?

  • Simple file viewer: OSS + Model Derivative + Viewer
  • BIM 360 integration: Data Management + Model Derivative
  • Batch processing: OSS + Design Automation
  • Full workflow: All APIs
View APS Cheat Sheet Browse Documentation