Skip to main content

​
Installation

npm install nen-sdk-js
Requires Node 20+ (uses the native fetch API). Zero runtime dependencies.

​
Quick Start

import { NenDesktop } from "nen-sdk-js";

const client = new NenDesktop({ apiKey: "sk_nen_..." });

// Create a desktop
const desktop = await client.createDesktop();
const did = desktop.desktopId;

// Take a screenshot
const result = await client.screenshot(did);
// result.base64Image is a PNG, base64-encoded

// Click and type
await client.leftClick(did, 500, 400);
await client.typeText(did, "hello world");

// Clean up
await client.deleteDesktop(did);

​
Configuration

const client = new NenDesktop({
  apiKey: "sk_nen_...",
  baseUrl: "https://desktop.api.getnen.ai", // default
  timeout: 30_000,                           // default (milliseconds)
});
The execute() method always uses a 120-second timeout, regardless of the client timeout.

​
Method Reference

​
Desktop CRUD

MethodReturnsDescription
createDesktop(desktopType?)Promise<Desktop>Create a new desktop ("sandbox" by default)
listDesktops()Promise<Desktop[]>List all active desktops
getDesktop(desktopId)Promise<Desktop>Get a single desktop by ID
updateDesktop(desktopId, { name })Promise<Desktop>Rename a desktop
deleteDesktop(desktopId)Promise<DeleteResponse>Delete a desktop

​
Computer-Use Helpers

Typed shortcuts — no need to know the wire format:
MethodDescription
screenshot(desktopId)Take a screenshot
leftClick(desktopId, x, y)Left click at coordinate
rightClick(desktopId, x, y)Right click at coordinate
doubleClick(desktopId, x, y)Double click at coordinate
middleClick(desktopId, x, y)Middle click at coordinate
mouseMove(desktopId, x, y)Move cursor to coordinate
typeText(desktopId, text)Type text
keyPress(desktopId, key)Press a key or combo (e.g. "ctrl+a")
scroll(desktopId, x, y, { direction, amount? })Scroll at coordinate
cursorPosition(desktopId)Get current cursor position

​
Tool Execution

MethodReturnsDescription
execute(desktopId, { tool, action, params? })Promise<ExecuteResult>Execute any tool action (raw)
listTools(desktopId)Promise<ToolSchema[]>List available tools as JSON Schema
getToolLogs(desktopId)Promise<unknown[]>Get tool execution logs

​
Sessions

MethodReturnsDescription
createSession(desktopId)Promise<SessionInfo>Create or reconnect an RDP session
getSession(desktopId)Promise<SessionInfo>Get current session status
deleteSession(desktopId)Promise<void>Disconnect the session

​
Files

Per-desktop shared drive (EFS-backed; persists across controller rebinds; 100 MiB upload cap). All three methods accept an optional options.path that selects a subdirectory; uploadFile creates missing intermediate directories on the server.
MethodReturnsDescription
listFiles(desktopId, options?)Promise<File[]>List files on the desktop’s drive. Entries have isDir: true for directories.
uploadFile(desktopId, name, body, options?)Promise<UploadFileResponse>Upload Uint8Array / ArrayBuffer / string / Blob; options.contentType defaults to application/octet-stream.
downloadFile(desktopId, name, options?)Promise<Uint8Array>Download a file as raw bytes.
// Upload, list, then download.
const body = new TextEncoder().encode("hello from JS\n");
const up = await client.uploadFile(did, "hello.txt", body, { contentType: "text/plain" });
console.log(`${up.size} bytes uploaded as ${up.filename}`);

for (const entry of await client.listFiles(did)) {
  console.log(entry.name + (entry.isDir ? "/" : ""), entry.size);
}

// Round-trip within a subdirectory.
await client.uploadFile(did, "hello.txt", body, { contentType: "text/plain", path: "Documents" });
for (const entry of await client.listFiles(did, { path: "Documents" })) {
  console.log(entry.name);
}
const raw = await client.downloadFile(did, "hello.txt", { path: "Documents" });
The File interface shadows the DOM File — if you need both, alias it: import type { File as NenFile } from "nen-sdk-js".

​
Error Handling

All API errors throw NenDesktopError, which carries statusCode and responseBody: 
import { NenDesktop, NenDesktopError } from "nen-sdk-js";

const client = new NenDesktop({ apiKey: "sk_nen_..." });

try {
  await client.getDesktop("dsk_nonexistent");
} catch (e) {
  if (e instanceof NenDesktopError) {
    console.log(`Error ${e.statusCode}: ${e.responseBody}`);
  }
}
The JS SDK does not subclass by status code — inspect e.statusCode to differentiate (401, 404, 409, 5xx).