Documentation

OmniRun documentation

Isolated virtual machines for AI agents. One API call to create, one to destroy. Sandboxes typically start in under a second (snapshot restore) and each runs its own kernel.

Start here

Two ways to your first sandbox. Both SDKs wrap the same REST API.

~60 s

Quick start

Install the TypeScript SDK, create a sandbox, run code, move files and tear it down.

$npm install @omnirun/sdkRead the quick start

Python

Python SDK

The same flow from Python, with sync and async clients over the same REST API.

$# Python SDK: coming soonRead the Python guide

Browse the docs

Guides and reference, grouped by what you are doing.

Getting started

What a sandbox is, how it starts, and the calls you need: create, run, kill.

Introduction Quick start Templates

SDKs

OmniRun SDKs for TypeScript and Python. Both wrap the same REST API.

TypeScript SDK Python SDK Desktop sandbox

REST API

Endpoints for sandboxes, commands, files and exposures. Base URL api.omnirun.io.

Sandboxes Commands Files

Sandboxes

Internet on or off per sandbox, the opt-in SNI proxy, file transfer and limits.

Networking File transfer Limits

Agents and models

The LLM proxy, the vault, Claude Managed Agents and OpenClaw.

LLM proxy and vault Claude Managed Agents OpenClaw

Security and reference

The isolation model, start-up times and the changelog.

Security model Benchmarks Changelog

Create a sandbox in one call

import { Sandbox } from '@omnirun/sdk';

const sandbox = await Sandbox.create('playground', {
  timeout: 300,
});

// sandbox.sandboxId → "sb_a1b2c3d4"

from omnirun import Sandbox

sandbox = Sandbox.create(
  "playground",
  timeout=300,
)

# sandbox.sandboxId → "sb_a1b2c3d4"

$ curl -X POST https://api.omnirun.io/sandboxes \
  -H "Authorization: Bearer $OMNIRUN_KEY" \
  -d '{"template": "playground",
       "timeout": 300}'

Reads OMNIRUN_API_KEY from your environment.

What happens

01
Create
The API restores a microVM from the template’s memory snapshot. Typically under a second.
02
Run
Commands and code run inside the guest, under its own kernel.
03
Kill
The VM stops and its sandbox is removed.