Skip to main content

Documentation Index

Fetch the complete documentation index at: https://novita.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

E2B Desktop is an open-source secure virtual desktop framework specifically engineered for developing Computer Use Agents. This solution provides a comprehensive, isolated desktop environment that enables AI agents to securely interact with desktop applications through controlled virtualization. This document will provide detailed instructions on how to run this project based on Novita Agent sandbox service.

​
1. Get Novita API Key

​
2. Environment Configuration

Before you start using the service, you need to configure the necessary environment variables:
Bash
export E2B_DOMAIN=sandbox.novita.ai
export E2B_API_KEY=<Your API key obtained in the previous step>
Running example: Setup Environment Variables

​
3. SDK Installation

Select the appropriate installation method corresponding to your development environment and programming language: 
npm i @e2b/desktop@2.0.1

​
4. Implementation Examples

​
Get Virtual Desktop Stream VNC URL

The following implementation demonstrates the instantiation of a virtual desktop environment and the retrieval of VNC access endpoints for remote desktop interaction: 
// demo.ts implementation
import { Sandbox } from '@e2b/desktop'

// Initialize virtual desktop sandbox instance
const desktop = await Sandbox.create()

// Activate desktop streaming service
await desktop.stream.start()

// Retrieve interactive VNC endpoint URL
const url = desktop.stream.getUrl()
console.log(url)

// Expected output format:
// Browser-accessible URL for interactive virtual desktop session. Suitable for application integration.
// https://6080-ik0n7lc3j0dvqd4jxy6g7.sandbox.novita.ai/vnc.html?autoconnect=true&resize=scale

// Retrieve read-only VNC endpoint URL (interaction disabled)
const urlDisabledInteraction = desktop.stream.getUrl({ viewOnly: true })
console.log(urlDisabledInteraction)
// Expected output format:
// Browser-accessible URL for view-only virtual desktop session (non-interactive mode). Suitable for monitoring applications.
// https://6080-ik0n7lc3j0dvqd4jxy6g7.sandbox.novita.ai/vnc.html?autoconnect=true&view_only=true&resize=scale

// Keep the program running
console.log("Desktop stream started, press Ctrl+C to stop the program...")
const interval = setInterval(() => {}, 1000)

// Register interrupt signal handlers for resource cleanup
let isCleaning = false
const cleanup = async () => {
    if (isCleaning) return
    isCleaning = true
    
    console.log("\nProgram interrupted, cleaning up resources...")
    clearInterval(interval)
    try {
        await desktop.stream.stop() // Terminate streaming service
        await desktop.kill()        // Deallocate sandbox instance
    } catch (err) {
        console.error("Error cleaning up resources:", err)
    }
    process.exit(0)
}

process.on('SIGINT', cleanup)
process.on('SIGTERM', cleanup)
Running example: Run Example Access virtual desktop stream VNC URL: Desktop Streaming Additional implementation examples and advanced use cases are available in the official E2B Desktop repository.