Package {AutoDeskR}

Type:	Package
Title:	An Interface to the 'AutoDesk' 'API' Platform
Description:	An interface to the 'AutoDesk' Platform Services ('APS') 'API' including the Authentication 'API' for obtaining 'OAuth2' tokens with expiry tracking, Data Management 'API' for managing buckets and objects across the platform's cloud services, Design Automation 'API' for running automated tasks on design files in the cloud, Model Derivative 'API' for translating design files into 'SVF', 'SVF2', 'OBJ', and 'STL' formats and extracting model data, Reality Capture 'API' for generating 3D models from photogrammetry image sets, and Viewer for rendering 2D and 3D models in 'Shiny' applications.
Version:	0.5.0
URL:	https://aps.autodesk.com, https://github.com/paulgovan/AutoDeskR, https://paulgovan.github.io/AutoDeskR-Book/
BugReports:	https://github.com/paulgovan/AutoDeskR/issues
Depends:	R (≥ 4.1.0)
License:	Apache License version 1.1 | Apache License version 2.0 | file LICENSE [expanded from: Apache License | file LICENSE]
Imports:	curl, httr2, jsonlite, shiny
Encoding:	UTF-8
RoxygenNote:	7.3.3
Suggests:	ellmer, knitr, mcptools, rmarkdown, testthat (≥ 3.0.0), httptest2, tibble, withr
Config/testthat/edition:	3
NeedsCompilation:	no
Packaged:	2026-05-28 13:26:52 UTC; paulgovan
Author:	Paul Govan [aut, cre, cph]
Maintainer:	Paul Govan <paul.govan2@gmail.com>
Repository:	CRAN
Date/Publication:	2026-05-28 14:20:15 UTC

Create an APS API Error Condition.

Description

Create a structured error condition for failures returned by the AutoDesk Platform Services (APS) API. Callers can use tryCatch(..., aps_error = function(e) ...) to handle these errors.

Usage

aps_error(message, status, body, call = sys.call(-1))

Arguments

Value

A condition object of class c("aps_error", "error", "condition").

Examples

## Not run: 
tryCatch(
  makeBucket(token = "bad_token"),
  aps_error = function(e) cat("HTTP", e$status, "-", e$message)
)

## End(Not run)

Convert a listBuckets Response to a Tibble.

Description

Requires the tibble package.

Usage

## S3 method for class 'listBuckets'
as_tibble(x, ...)

Arguments

Value

A tibble with one row per bucket and columns bucketKey, bucketOwner, and policyKey.

Examples

## Not run: 
library(tibble)
listBuckets(token = myToken) |> as_tibble()

## End(Not run)

Convert a listObjects Response to a Tibble.

Description

Requires the tibble package.

Usage

## S3 method for class 'listObjects'
as_tibble(x, ...)

Arguments

Value

A tibble with one row per object and columns objectKey, objectId, size, and location.

Examples

## Not run: 
library(tibble)
listObjects(token = myToken, bucket = "mybucket") |> as_tibble()

## End(Not run)

MCP tools for AutoDeskR

Description

Returns a named list of ellmer::tool() objects that expose AutoDeskR functions to AI models via the Model Context Protocol (MCP). Credentials are read from the APS_CLIENT_ID and APS_CLIENT_SECRET environment variables; no token argument is required in any tool call.

Usage

autodeskr_mcp_tools()

Value

A named list of ellmer::tool objects covering Authentication, Data Management, Model Derivative, Design Automation, and Reality Capture.

Examples

## Not run: 
Sys.setenv(APS_CLIENT_ID = "your_id", APS_CLIENT_SECRET = "your_secret")
tools <- autodeskr_mcp_tools()
mcptools::mcp_server(tools = tools)

## End(Not run)

Check the Status of an App-Managed Bucket.

Description

Check the status of a recently created app-managed bucket using the Data Management API.

Usage

checkBucket(token = NULL, bucket = "mybucket")

Arguments

Value

An object containing the bucketKey, bucketOwner, and createdDate.

Examples

## Not run: 
# Check the status of a bucket with the name "mybucket"
resp <- checkBucket(token = myToken, bucket = "mybucket")
resp

## End(Not run)

Check the Status of a Translated File.

Description

Check the status of a recently translated file using the Model Derivative API.

Usage

checkFile(urn = NULL, token = NULL)

Arguments

Examples

## Not run: 
# Check the status of the translated "aerial.dwg" svf file
resp <- checkFile(urn = myEncodedUrn, token = myToken)
resp

## End(Not run)

Check the Status of a PDF WorkItem.

Description

Check the status of a Design Automation WorkItem using the Design Automation API v3.

Usage

checkPdf(id = NULL, token = NULL, source = NULL, destination = NULL)

Arguments

Value

An object containing the WorkItem id, status, and stats.

Examples

## Not run: 
mySource <- "http://download.autodesk.com/us/samplefiles/acad/visualization_-_aerial.dwg"
myDestination <- "https://example.com/output/aerial.pdf"
resp <- makePdf(mySource, myDestination, token = myToken)
myWorkItemId <- resp$content$id

# Poll for completion
resp <- checkPdf(id = myWorkItemId, token = myToken)
resp

## End(Not run)

Check Reality Capture Processing Progress.

Description

Poll the processing status of a photoscene. Use waitForPhotoscene to block until processing completes.

Usage

checkPhotoscene(photoscene_id = NULL, token = NULL)

Arguments

Value

An object of class checkPhotoscene containing resp$content$photoscene$progress (percentage string) and resp$content$photoscene$progressmsg.

Examples

## Not run: 
status <- checkPhotoscene(photoscene_id = myPhotosceneId, token = myToken)
status$content$photoscene$progress

## End(Not run)

Create a Photoscene for Reality Capture.

Description

Create a new photoscene for photogrammetry processing using the Reality Capture API. Upload images with uploadImages, then start processing with processPhotoscene.

Usage

createPhotoscene(name = NULL, format = "rcm", token = NULL)

Arguments

Value

An object of class createPhotoscene containing the photosceneid at resp$content$photoscene$photosceneid.

Examples

## Not run: 
ps <- createPhotoscene(name = "my-scene", format = "obj", token = myToken)
myPhotosceneId <- ps$content$photoscene$photosceneid

## End(Not run)

Delete an App-Managed Bucket.

Description

Delete an app-managed bucket using the Data Management API.

Usage

deleteBucket(token = NULL, bucket = "mybucket")

Arguments

Value

An object containing the HTTP status code of the response.

Examples

## Not run: 
# Delete a bucket named "mybucket"
resp <- deleteBucket(token = myToken, bucket = "mybucket")

## End(Not run)

Delete an Object from an App-Managed Bucket.

Description

Delete an object from an app-managed bucket using the Data Management API.

Usage

deleteObject(token = NULL, bucket = "mybucket", object = NULL)

Arguments

Value

An object containing the HTTP status code of the response.

Examples

## Not run: 
# Delete the "aerial.dwg" object from "mybucket"
resp <- deleteObject(token = myToken, bucket = "mybucket", object = "aerial.dwg")

## End(Not run)

Download a file locally.

Description

Download a file from the AutoDesk Platform Services using the Model Derivative API.

Usage

downloadFile(urn = NULL, output_urn = NULL, token = NULL, destfile = NULL)

Arguments

Value

An object containing either parsed JSON content or, for binary responses, the path to the saved file.

Examples

## Not run: 
# Download the "aerial.dwg" obj file
myEncodedOutputUrn <- jsonlite::base64_enc(myOutputUrn)
resp <- downloadFile(urn <- myEncodedUrn, output_urn <- myEncodedOutputUrn,
           token = myToken, destfile = "aerial.obj")

## End(Not run)

Get the Geometry Data for a File.

Description

Get the geometry of an uploaded file using the Model Derivative API.

Usage

getData(guid = NULL, urn = NULL, token = NULL)

Arguments

Value

An object containing the geometry data for the selected file.

Examples

## Not run: 
# Get the geometry data for the "aerial.dwg" svf file
resp <- getData(guid = myGuid, urn = myEncodedUrn, token = myToken)

## End(Not run)

Get the Metadata for a File.

Description

Get the metadata of an uploaded file using the Model Derivative API.

Usage

getMetadata(urn = NULL, token = NULL)

Arguments

Value

An object containing the type, name, and guid of the file.

Examples

## Not run: 
# Get the metadata for the "aerial.dwg" svf file
resp <- getMetadata(urn <- myEncodedUrn, token = myToken)
myGuid <- resp$content$data$metadata[[1]]$guid

## End(Not run)

Get the Object Tree of a File.

Description

Get the object tree of an uploaded file using the Model Derivative API.

Usage

getObjectTree(guid = NULL, urn = NULL, token = NULL)

Arguments

Value

An object containing the object tree for the selected file.

Examples

## Not run: 
# Get the object tree for the "aerial.dwg" svf file
resp <- getObjectTree(guid = myGuid, urn = myEncodedUrn, token = myToken)
resp

## End(Not run)

Get the Output URN for a File.

Description

Get the output urn of a translated file using the Model Derivative API.

Usage

getOutputUrn(urn, token)

Arguments

Value

An object containing the result, urn, and additional activity information.

Examples

## Not run: 
# Get the output urn for the "aerial.dwg" obj file
resp <- getOutputUrn(urn = myUrn, token = Sys.getenv("token"))
resp

## End(Not run)

Get a 2-Legged Token for Authentication.

Description

Get a 2-legged token for OAuth-based authentication to the AutoDesk Platform Services (APS).

Usage

getToken(id = NULL, secret = NULL, scope = "data:write data:read")

Arguments

Value

An aps_token object containing the access_token, token_type, expires_in, and expires_at. The token can be passed directly to other AutoDeskR functions. Use is_expired to check whether the token needs refreshing. Legacy access via resp$content$access_token continues to work.

Examples

## Not run: 
tok <- getToken(id = Sys.getenv("client_id"), secret = Sys.getenv("client_secret"),
         scope = "data:write data:read")
myToken <- tok$access_token
is_expired(tok)

## End(Not run)

Check Whether an aps_token Has Expired.

Description

Check Whether an aps_token Has Expired.

Usage

is_expired(token)

Arguments

Value

Logical. TRUE if the token has expired, FALSE otherwise.

Examples

## Not run: 
tok <- getToken(id = Sys.getenv("client_id"), secret = Sys.getenv("client_secret"))
is_expired(tok)

## End(Not run)

List All App-Managed Buckets.

Description

List all app-managed buckets using the Data Management API.

Usage

listBuckets(token = NULL, limit = 10, startAt = NULL, region = "US")

Arguments

Value

An object containing a list of bucket details.

Examples

## Not run: 
# List all buckets
resp <- listBuckets(token = myToken)
resp$content$items

## End(Not run)

List Objects in an App-Managed Bucket.

Description

List objects stored in an app-managed bucket using the Data Management API.

Usage

listObjects(token = NULL, bucket = "mybucket", limit = 10)

Arguments

Value

An object containing a list of objects in the bucket.

Examples

## Not run: 
# List objects in "mybucket"
resp <- listObjects(token = myToken, bucket = "mybucket")
resp$content$items

## End(Not run)

Make a Bucket for an App.

Description

Make an app-based bucket for storage of design files using the Data Management API.

Usage

makeBucket(token = NULL, bucket = "mybucket", policy = "transient")

Arguments

Value

An object containing the bucketKey, bucketOwner, and createdDate.

Examples

## Not run: 
# Make a transient bucket with the name "mybucket"
resp <- makeBucket(token = myToken, bucket = "mybucket", policy = "transient")

## End(Not run)

Convert a DWG to a PDF.

Description

Convert a publicly accessible DWG file to a publicly accessible PDF using the Design Automation API v3.

Usage

makePdf(source = NULL, destination = NULL, token = NULL)

Arguments

Value

An object containing the WorkItem id, status, and stats. Use id with checkPdf to poll for completion, or use waitForWorkItem to block until done.

Examples

## Not run: 
mySource <- "http://download.autodesk.com/us/samplefiles/acad/visualization_-_aerial.dwg"
myDestination <- "https://example.com/output/aerial.pdf"
resp <- makePdf(mySource, myDestination, token = myToken)
myWorkItemId <- resp$content$id

## End(Not run)

Start Reality Capture Processing.

Description

Initiate photogrammetry processing for a photoscene that has had images uploaded via uploadImages.

Usage

processPhotoscene(photoscene_id = NULL, token = NULL)

Arguments

Value

An object of class processPhotoscene containing the processing response.

Examples

## Not run: 
proc <- processPhotoscene(photoscene_id = myPhotosceneId, token = myToken)

## End(Not run)

Translate a File into OBJ Format.

Description

Translate an uploaded file into OBJ format using the Model Derivative API.

Usage

translateObj(urn = NULL, token = NULL)

Arguments

Value

An object containing the result, urn, and additional activity information.

Examples

## Not run: 
# Translate the "aerial.dwg" file into an obj file
resp <- translateObj(urn = myEncodedUrn, token = myToken)

## End(Not run)

Translate a File into STL Format.

Description

Translate an uploaded file into STL format using the Model Derivative API.

Usage

translateStl(urn = NULL, token = NULL)

Arguments

Value

An object containing the result, urn, and additional activity information.

Examples

## Not run: 
# Translate the "aerial.dwg" file into an stl file
resp <- translateStl(urn = myEncodedUrn, token = myToken)

## End(Not run)

Translate a File into SVF Format.

Description

Translate an uploaded file into SVF format using the Model Derivative API.

Usage

translateSvf(urn = NULL, token = NULL)

Arguments

Value

An object containing the result, urn, and additional activity information.

Examples

## Not run: 
# Translate the "aerial.dwg" file into a svf file
myEncodedUrn <- jsonlite::base64_enc(myUrn)
resp <- translateSvf(urn = myEncodedUrn, token = myToken)

## End(Not run)

Translate a File into SVF2 Format.

Description

Translate an uploaded file into SVF2 format using the Model Derivative API. SVF2 is the next-generation viewer format: approximately 30 SVF and faster to load in the Autodesk Viewer. Use it in place of translateSvf for new projects.

Usage

translateSvf2(urn = NULL, token = NULL, views = c("2d", "3d"))

Arguments

Value

An object containing the result, urn, and additional activity information.

Examples

## Not run: 
# Translate the "aerial.dwg" file into SVF2 format
myEncodedUrn <- jsonlite::base64_enc(myUrn)
resp <- translateSvf2(urn = myEncodedUrn, token = myToken)

## End(Not run)

Upload a File to an App-Managed Bucket.

Description

Upload a design file to an app-managed bucket using the Data Management API.

Usage

uploadFile(file = NULL, token = NULL, bucket = "mybucket")

Arguments

Value

An object containing the bucketKey, objectId (i.e. urn), objectKey (i.e. file name), size, contentType (i.e. "application/octet-stream"), location. and other content information.

Examples

## Not run: 
# Upload the "aerial.dwg" file to "mybucket"
resp <- uploadFile(file = system.file("inst/samples/aerial.dwg", package = "AutoDeskR"),
           token = myToken, bucket = "mybucket")
myUrn <- resp$content$objectId

## End(Not run)

Upload a File Using Signed S3 URLs.

Description

Upload a design file of any size to an app-managed bucket using the signed S3 URL approach recommended by AutoDesk Platform Services (APS). Unlike uploadFile, this function supports files larger than 100 MB.

Usage

uploadFileSigned(file = NULL, token = NULL, bucket = "mybucket")

Arguments

Value

An object containing the finalized upload response with bucketKey, objectId, objectKey, size, and location.

Examples

## Not run: 
# Upload a large file using signed S3 URLs
resp <- uploadFileSigned(
  file   = "path/to/large_model.rvt",
  token  = myToken,
  bucket = "mybucket"
)
myUrn <- resp$content$objectId

## End(Not run)

Upload Images to a Photoscene.

Description

Upload one or more image files to an existing photoscene for Reality Capture processing.

Usage

uploadImages(photoscene_id = NULL, files = NULL, token = NULL)

Arguments

Value

An object of class uploadImages containing the upload response.

Examples

## Not run: 
imgs <- uploadImages(
  photoscene_id = myPhotosceneId,
  files         = c("img1.jpg", "img2.jpg", "img3.jpg"),
  token         = myToken
)

## End(Not run)

Launch the Viewer.

Description

Launch the Viewer.

Usage

viewer3D(urn = NULL, token = NULL, viewerType = "header")

Arguments

Examples

## Not run: 
# View the "aerial.dwg" file in the AutoDesk viewer
myEncodedUrn <- jsonlite::base64_enc(myUrn)
viewer3D(urn <- myEncodedUrn, token = myToken)

## End(Not run)

UI Module Function.

Description

UI Module Function.

Usage

viewerUI(id, urn = NULL, token = NULL, viewerType = "header")

Arguments

Examples

## Not run: 
ui <- function(request) {
 shiny::fluidPage(
   viewerUI("pg", myEncodedUrn, myToken)
 )
}
server <- function(input, output, session) {
}
shiny::shinyApp(ui, server)

## End(Not run)

Wait for a Model Derivative Translation to Complete.

Description

Polls checkFile at a fixed interval until the translation reaches a terminal state ("success", "failed", or "timeout").

Usage

waitForFile(urn, token, interval = 5, timeout = 300, verbose = TRUE)

Arguments

Value

The final checkFile response object.

Examples

## Not run: 
myEncodedUrn <- jsonlite::base64_enc(myUrn)
resp <- translateSvf(urn = myEncodedUrn, token = myToken)
done <- waitForFile(urn = myEncodedUrn, token = myToken)
done$content$status

## End(Not run)

Wait for Reality Capture Processing to Complete.

Description

Polls checkPhotoscene at a fixed interval until processing reaches 100% or an error occurs.

Usage

waitForPhotoscene(
  photoscene_id,
  token,
  interval = 30,
  timeout = 1800,
  verbose = TRUE
)

Arguments

Value

The final checkPhotoscene response object.

Examples

## Not run: 
ps   <- createPhotoscene("my-scene", token = myToken)
id   <- ps$content$photoscene$photosceneid
imgs <- uploadImages(id, c("img1.jpg", "img2.jpg"), myToken)
proc <- processPhotoscene(id, myToken)
done <- waitForPhotoscene(id, myToken)
done$content$photoscene$progress

## End(Not run)

Wait for a Design Automation WorkItem to Complete.

Description

Polls checkPdf at a fixed interval until the WorkItem reaches a terminal state (any status other than "inprogress" or "pending").

Usage

waitForWorkItem(id, token, interval = 5, timeout = 300, verbose = TRUE)

Arguments

Value

The final checkPdf response object.

Examples

## Not run: 
resp <- makePdf(source = mySource, destination = myDest, token = myToken)
done <- waitForWorkItem(id = resp$content$id, token = myToken)
done$content$status

## End(Not run)