Mudbase Cells Documentation

Start here

01Create your first session3 min 02Run commands and read output5 min 03Read and write files4 min 04Start a service, expose a port5 min 05Understand session lifetime3 min

Quick example

curlshell

# 1. Create a Node.js session
curl -X POST https://api.mudbase.dev/api/sandboxes/projects/{projectId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"language":"node","languageVersion":"22","timeoutSeconds":300}'

# Response: { "sessionId": "...", "wsUrl": "...", "token": "...", "timeoutAt": "..." }

# 2. Run a command (SSE stream)
curl -N -X POST https://api.mudbase.dev/api/sandboxes/projects/{projectId}/sessions/{sessionId}/exec \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cmd":["node","-e","console.log(42)"]}'
# 1. Create a Node.js session
curl -X POST https://api.mudbase.dev/api/sandboxes/projects/{projectId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"language":"node","languageVersion":"22","timeoutSeconds":300}'

# Response: { "sessionId": "...", "wsUrl": "...", "token": "...", "timeoutAt": "..." }

# 2. Run a command (SSE stream)
curl -N -X POST https://api.mudbase.dev/api/sandboxes/projects/{projectId}/sessions/{sessionId}/exec \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cmd":["node","-e","console.log(42)"]}'

Supported runtimes

One API, eight languages. Pick the runtime you need when you create a session.

Node 22 Python 3.12 Go 1.23 Rust 1.82 PHP 8.3 Java 21 Ruby 3.3 C# .NET 8

Core concepts

CELL

Sessions and Cells

Ephemeral sessions vs. named cells with persistent volumes.

EXEC

Run Commands

SSE streaming, keepalive, timeoutMs up to 300s.

FILES

Files

Batch-write up to 200 files; read any file up to 10 MB.

SVC

Services

Start a long-running process and expose its port.

PLAN

Plans

Included hours, concurrency limits, and alwaysOn tiers.

API

REST API

Full OpenAPI reference with request and response schemas.

Client library examples

Generate from spec

No published SDK package exists yet. Generate a typed client from the OpenAPI spec, or use the REST API directly. The examples below show the API shape of a generated client.

Generated client shape

import { CellsClient } from "mudbase-cells-sdk";

const cells = new CellsClient({
  apiKey: process.env.CELLS_API_KEY,
  projectId: process.env.CELLS_PROJECT_ID,
});

const session = await cells.sessions.create({
  language: "node",
  languageVersion: "22",
  timeoutSeconds: 300,
});

const result = await cells.exec(session.sessionId, {
  cmd: ["node", "-e", "console.log(42)"],
});

console.log(result.stdout); // "42"
await cells.sessions.close(session.sessionId);

import { CellsClient } from "mudbase-cells-sdk";

const cells = new CellsClient({
  apiKey: process.env.CELLS_API_KEY,
  projectId: process.env.CELLS_PROJECT_ID,
});

const session = await cells.sessions.create({
  language: "node",
  languageVersion: "22",
  timeoutSeconds: 300,
});

const result = await cells.exec(session.sessionId, {
  cmd: ["node", "-e", "console.log(42)"],
});

console.log(result.stdout); // "42"
await cells.sessions.close(session.sessionId);

from mudbase_cells import CellsClient

cells = CellsClient(
    api_key=os.environ["CELLS_API_KEY"],
    project_id=os.environ["CELLS_PROJECT_ID"],
)

session = cells.sessions.create(
    language="python",
    language_version="3.12",
    timeout_seconds=300,
)

result = cells.exec(session.session_id, cmd=["python3", "-c", "print(42)"])
print(result.stdout)  # "42"
cells.sessions.close(session.session_id)

from mudbase_cells import CellsClient

cells = CellsClient(
    api_key=os.environ["CELLS_API_KEY"],
    project_id=os.environ["CELLS_PROJECT_ID"],
)

session = cells.sessions.create(
    language="python",
    language_version="3.12",
    timeout_seconds=300,
)

result = cells.exec(session.session_id, cmd=["python3", "-c", "print(42)"])
print(result.stdout)  # "42"
cells.sessions.close(session.session_id)