SDK Reference

wirtual.dev provides official SDKs and client libraries to help you integrate simulation environments into your applications and workflows. Our SDKs offer type-safe, idiomatic ways to interact with the wirtual.dev API in your preferred programming language.

​

Available SDKs

pip install wirtual-sdk

npm install @wirtual/sdk

​

Core Features

​

Quick Start

​

Python

from wirtual import Client

# Initialize client
client = Client()

# Create environment
env = client.create_environment(
    name="my-sim",
    template="robot-arm",
    parameters={
        "robot_type": "6dof",
        "gpu_enabled": True
    }
)

# Start environment
env.start()

​

JavaScript/TypeScript

import { WirtualClient } from '@wirtual/sdk'

// Initialize client
const client = new WirtualClient()

// Create environment
const env = await client.createEnvironment({
  name: 'my-sim',
  template: 'robot-arm',
  parameters: {
    robotType: '6dof',
    gpuEnabled: true
  }
})

// Start environment
await env.start()

​

Authentication

from wirtual import Client

client = Client(
    token="your-api-token"
)

​

Common Operations

​

Managing Environments

# List environments
envs = client.list_environments()

# Get specific environment
env = client.get_environment("my-sim")

# Stop environment
env.stop()

# Delete environment
env.delete()

​

Working with Templates

# List templates
templates = client.list_templates()

# Get template details
template = client.get_template("robot-arm")

# Create from template
env = client.create_environment(
    template=template.name,
    parameters=template.default_parameters
)

​

SDK-Specific Features

​

Python SDK

• Async/await support

• Type hints

• Context managers

• Pandas integration

​

JavaScript/TypeScript SDK

• Promise-based API

• Full TypeScript support

• Browser and Node.js compatibility

• Automatic retry handling

​

Best Practices

try:
    env = client.create_environment(...)
except WirtualError as e:
    logger.error(f"Failed to create environment: {e}")

with client.create_environment(...) as env:
    # Use environment
    pass  # Auto-cleanup on exit

​

SDK Documentation