Documentation / VRED APIs

VRED APIs

Automate scene setup and customize immersive design reviews

Use the VRED Python API to control scenes, materials, lighting, cameras, and rendering settings in Autodesk VRED. Automate design review workflows, build custom VR interactions, or connect VRED to your CAD and PLM pipelines. View the API documentation to get started. 

Fundamentals

If you're looking to explore the API further, here are some basic resources to get started. The VRED Python API is available in VRED Professional and VRED Design only. Python scripting is not supported in VRED Basic.

API practical usage

Discover tips and methods for using the VRED Python API in your everyday development tasks. Automate scene workflows, connect to external systems, or control VRED remotely from a web app. 

Scene and geometry

Access and modify the VRED scene graph using Python API v2 services. Query objects, apply constraints, run physics simulations, or automate placement across design variants in your scripts.

Materials, lighting, and rendering

Control how VRED scenes look and render using Python API v2 services. Manage materials and lights, bake textures, configure cameras, and add annotations or scene overlays from your scripts. 

Virtual reality and collaboration

Build custom VR interaction modes and manage multi-user sessions with Python API v2 services. Run immersive design reviews, sync live references from Alias, or customize the VR menu in your plug-ins. 

File I/O and automation

Load, save, and tag scene data, and automate production workflows with Python API v2 services. Sync metadata with PLM systems, batch-process files, or scale renders across a cluster.

Implementation

Dive deeper into the implementation details of the VRED Python API. Understand advanced techniques for working with data types, signal, field access, and the v1 and v2 interfaces in your applications. 

Plug-in development

Learn how to develop custom script plug-in for VRED. Follow step-by-step guides and best practices to extend and customize the functionality of VRED environment.

API examples

Explore real-world examples of scripts and plug-ins using the VRED Python API. Study these code samples to gain practical insights and inspiration for your own projects.

Community and support

Connect with other developers working with the VRED API. Ask questions, share tips, and learn from the community.