Quick Install

Core Components

Documentation Overview

Next Steps

Support

Set up your first AI simulation environment with wirtual.dev in under 5 minutes

Getting Started

Wirtual.dev

 wirtual.dev is a platform designed to accelerate physical AI development by providing instant-deploy simulation environments. Our platform enables developers and companies to train and test AI agents in Wirtual environments before deploying them to real-world robots, autonomous vehicles, and other physical systems.

Welcome to wirtual.dev

Step-by-step guides for common physical AI development scenarios

Cookbook

Watch step-by-step demonstrations of wirtual.dev features and capabilities

Demo Recordings

Pre-configured simulation environments for physical AI development

Environment Templates

Learn how to create and configure environment templates for physical AI development

Template Basics

API Reference

API root handler

Build info

Report CSP violations

Get deployment config

SSH Config

Get deployment stats

Get enabled experiments

Get safe experiments

Update check

Get token config

Get appearance

Update appearance

Issue signed app token for reconnecting PTY

Get entitlements

Get groups

Get group by ID

Delete group by name

Update group by name

Get JFrog XRay scan by workspace agent ID.

Post JFrog XRay scan by workspace agent ID.

Get licenses

Delete license

Update notification template dispatch method

Get OAuth2 applications.

Create OAuth2 application.

Get OAuth2 application.

Update OAuth2 application.

Delete OAuth2 application.

Get OAuth2 application secrets.

Create OAuth2 application secret.

Delete OAuth2 application secret.

OAuth2 authorization request.

OAuth2 token exchange.

Delete OAuth2 application tokens.

Get groups by organization

Create group for organization

Get group by organization and group name

Get workspace quota by user

Get provisioner daemons

Serve provisioner daemon

List provisioner key

Create provisioner key

List provisioner key daemons

Delete provisioner key

Get the available organization idp sync claim fields

Get group IdP Sync settings by organization

Update group IdP Sync settings by organization

Get role IdP Sync settings by organization

Update role IdP Sync settings by organization

Get active replicas

SCIM 2.0: Service Provider Config

SCIM 2.0: Get users

SCIM 2.0: Create new user

SCIM 2.0: Get user by ID

SCIM 2.0: Update user account

Get organization IdP Sync settings

Update organization IdP Sync settings

Get template ACLs

Update template ACL

Get template available acl users/groups

Get user quiet hours schedule

Update user quiet hours schedule

Get workspace quota by user deprecated

Get workspace proxies

Create workspace proxy

Report workspace app stats

Workspace Proxy Coordinate

Get workspace proxy crypto keys

Deregister workspace proxy

Issue signed workspace app token

Register workspace proxy

Get workspace proxy

Delete workspace proxy

Update workspace proxy

Redirect to URI with encrypted API key

Get applications host

Get audit logs

Generate fake audit log

Check authorization

Log in user

Change password with a one-time passcode

Request one-time passcode

Validate user password

Convert user from password to oauth authentication

Debug Info Wireguard Coordinator

Debug DERP traffic

Debug expvar

Debug Info Deployment Health

Get health settings

Update health settings

Debug Info Tailnet

Debug Info Websocket Test

Debug OIDC context for a user

Get DERP map updates

User-scoped tailnet RPC connection

Authenticate agent on AWS instance

Authenticate agent on Azure instance

Get connection info for workspace agent generic

Authenticate agent on Google Cloud instance

Get workspace agent external auth

Removed: Get workspace agent git auth

Get workspace agent Git SSH key

Post workspace agent log source

Patch workspace agent logs

Workspace agent RPC API

Get workspace agent by ID

Get connection info for workspace agent

Coordinate workspace agent

Get listening ports for workspace agent

Get logs by workspace agent

Open PTY to workspace agent

Removed: Get logs by workspace agent

Watch for workspace agent metadata updates

Get user external auths

Get external auth by ID

Delete external auth user link by ID

Get external auth device by ID.

Post external auth device by ID

Swagger notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.

Upload file

Get file by ID

Get deployment DAUs

Get insights about templates

Get insights about user activity

Get insights about user latency

Add new license

Update license entitlements

Get organizations

Create organization

Get organization by ID

Delete organization

Update organization

Get notification dispatch methods

Get notifications settings

Update notifications settings

Get system notification templates

Get user notification preferences

Update user notification preferences

List organization members

Get member roles by organization

Upsert a custom organization role

Insert a custom organization role

Delete a custom organization role

Add organization member

Remove organization member

Assign role to organization member

Get site member roles

Create a new workspace using a template. The request must
specify either the Template ID or the Template Version ID,
not both. If the Template ID is specified, the active version
of the template will be used.

Create user workspace by organization

Get workspace metadata by user and workspace name

Create user workspace

List workspaces

Get workspace metadata by ID

Update workspace metadata by ID

Update workspace autostart schedule by ID

Update workspace automatic updates by ID

Update workspace dormancy status by id.

Extend workspace deadline by ID

Favorite workspace by ID.

Unfavorite workspace by ID.

Resolve workspace autostart by id.

Get workspace timings by ID

Update workspace TTL by ID

Post Workspace Usage by ID

Watch workspace by ID

Get templates by organization

Create template by organization

Get template examples by organization

Get templates by organization and template name

Get template version by organization, template, and name

Get previous template version by organization, template, and name

Create template version by organization

Get all templates

Get template examples

Get template metadata by ID

Delete template by ID

Update template metadata by ID

Get template DAUs by ID

List template versions by template ID

Update active template version by template ID

Archive template unused versions by template id

Get template version by template ID and name

Get Started

Getting Started

Quick Install

Core Components

Environment Templates

Workspaces

Development Tools

Documentation Overview

Cookbook

Demo Recordings

Environment Templates

API Reference

SDK Reference

CLI Reference

Next Steps

Support

Watch Demos

CLI Reference

Generate Support Bundle

Get Started

​Quick Install

​Core Components

Environment Templates

Workspaces

Development Tools

​Documentation Overview

Cookbook

Demo Recordings

Environment Templates

API Reference

SDK Reference

CLI Reference

​Next Steps

​Support

Watch Demos

CLI Reference

Generate Support Bundle

Quick Install

Core Components

Documentation Overview

Next Steps

Support