Docs / Python SDK

The Python client, end to end.

Covers ovrin.Client, sandbox lifecycle, the filesystem and browser handles, and cross-session memory. The TypeScript SDK mirrors this API 1:1.

Install

$ pip install ovrin

$ uv add ovrin

Initialize

import ovrin # reads OVRIN_API_KEY from the environment if omitted client = ovrin.Client(api_key="sk_live_...")

Client(api_key=None, base_url=None)Creates a client. Reads OVRIN_API_KEY from the environment when api_key is omitted.

.create(template, env=None, timeout=3600, cpu=None, memory=None)Boots a new sandbox from a template and returns a Sandbox handle.

.get(sandbox_id)Re-attaches to a running sandbox by id.

.list(state=None)Lists sandboxes for the current project, optionally filtered by state.

.run(command, timeout=None, stream=False)Executes a shell command inside the sandbox. Returns stdout, stderr and exit code.

.files.read(path)Reads a file from the sandbox filesystem.

.files.write(path, content)Writes a file into the sandbox filesystem, creating parent directories as needed.

.browser.launch(headless=True)Starts a Chrome + Playwright session inside the sandbox for browser automation.

.kill()Terminates the sandbox immediately. Filesystem and process state are discarded.

.add(text, tags=None)Writes a note to persistent cross-session memory, independent of any single sandbox's lifetime.

.search(query, limit=10)Retrieves the most relevant memory entries for a query.

Full API reference lives in the OpenAPI spec.

Every SDK method maps 1:1 to a REST endpoint — use the SDK for convenience or hit the API directly.