# MIOSA Documentation > MIOSA is an AI compute platform for sandboxes, desktop computers, deployments, managed data, SDKs, and white-label platform integration. Canonical docs: https://miosa.ai/docs Full plain-text docs: https://miosa.ai/llms-full.txt Docs index JSON: https://miosa.ai/docs-index.json OpenAPI spec: https://miosa.ai/openapi.yaml Sitemap: https://miosa.ai/sitemap.xml If an automated fetcher is blocked by Cloudflare on miosa.ai, use the Worker fallback for the same paths: - https://miosa.roberto-c49.workers.dev/docs - https://miosa.roberto-c49.workers.dev/llms.txt - https://miosa.roberto-c49.workers.dev/llms-full.txt - https://miosa.roberto-c49.workers.dev/docs-index.json - https://miosa.roberto-c49.workers.dev/openapi.yaml ## Primary Docs - [MIOSA Documentation](https://miosa.ai/docs) — Build, preview, and deploy AI-generated apps on managed compute — one workspace API key, your customers attributed. - [Interactive API Reference — MIOSA Docs](https://miosa.ai/docs/api) — Browse and try every MIOSA API endpoint interactively. Covers sandboxes, computers, deployments, API keys, events, and more. - [API Reference](https://miosa.ai/docs/api-reference) — REST API reference for the MIOSA platform — base URL, auth, request/response envelopes, and the full endpoint index. - [Computers API](https://miosa.ai/docs/api-reference/computers) — API reference for creating, managing, and controlling MIOSA computers — full lifecycle, desktop control, files, metrics, and env vars. - [Credits API](https://miosa.ai/docs/api-reference/credits) — API reference for checking credit balance, transaction history, and usage data. - [Custom Domains API](https://miosa.ai/docs/api-reference/custom-domains) — API reference for mapping tenant-owned FQDNs to MIOSA previews with automatic TLS. - [API Reference / Deployments](https://miosa.ai/docs/api-reference/deployments) — REST API for the Deployment resource — create, list, get, update, delete, publish, rollback. - [Desktop API](https://miosa.ai/docs/api-reference/desktop) — API reference for all desktop control endpoints — screenshot, mouse, keyboard, clipboard, windows, accessibility tree. - [Error Codes](https://miosa.ai/docs/api-reference/errors) — Every error code the MIOSA API returns, what it means, and how to handle it. - [Events (SSE)](https://miosa.ai/docs/api-reference/events) — Server-Sent Event streams for real-time updates from sandboxes, computers, deployments, and builds. - [Exec API](https://miosa.ai/docs/api-reference/exec) — API reference for executing bash commands and Python code on MIOSA computers. - [Files API](https://miosa.ai/docs/api-reference/files) — API reference for file upload, download, list, export, and delete operations. - [Filesystem API](https://miosa.ai/docs/api-reference/filesystem) — Complete API reference for file and directory operations on MIOSA computers — upload, download, stat, mkdir, rename, copy, chmod, and readdir. - [Network Policy API](https://miosa.ai/docs/api-reference/network-policy) — API reference for configuring per-computer network access controls on MIOSA computers. - [OpenComputers API](https://miosa.ai/docs/api-reference/open-computers) — Register and control your own machines (BYOC) via the MIOSA API — exec, files, tunnels, AI agents, inference clusters, and secrets. - [Projects API](https://miosa.ai/docs/api-reference/projects) — API reference for creating and managing projects inside MIOSA workspaces. - [Regions API](https://miosa.ai/docs/api-reference/regions) — List available regions and pin Computers and Sandboxes to a specific region. - [API Reference / Releases](https://miosa.ai/docs/api-reference/releases) — The immutable build artifact — static tarball or dynamic rootfs / OCI image, sha256-keyed. - [Sandboxes API](https://miosa.ai/docs/api-reference/sandboxes) — API reference for creating, managing, and executing code in MIOSA sandboxes — ephemeral Firecracker microVMs. - [Services API](https://miosa.ai/docs/api-reference/services) — API reference for managing long-running systemd services inside MIOSA computers. - [Snapshots API](https://miosa.ai/docs/api-reference/snapshots) — API reference for creating, listing, and restoring Firecracker VM snapshots (checkpoints). - [Streaming Exec API](https://miosa.ai/docs/api-reference/streaming-exec) — API reference for streaming command output in real-time from MIOSA computers via SSE. - [API Reference / Versions](https://miosa.ai/docs/api-reference/versions) — Immutable deployment version sub-resource. List, get, promote, archive. - [Workspaces API](https://miosa.ai/docs/api-reference/workspaces) — API reference for creating and managing MIOSA workspaces - the customer/client layer inside an organization. - [Authentication](https://miosa.ai/docs/authentication) — How to authenticate with the MIOSA API using msk_ API keys or JWT tokens. - [Changelog](https://miosa.ai/docs/changelog) — What's new in MIOSA — shipped features, SDK updates, and platform improvements. - [CLI Reference](https://miosa.ai/docs/cli) — Complete reference for the MIOSA CLI — manage computers, sandboxes, deployments, data services, and AI agents from your terminal. - [BYOC / OpenComputers](https://miosa.ai/docs/computers/byoc) — Register your own hardware (Mac, Linux, Windows). One command, your machine becomes a MIOSA computer. Apache 2.0. - [Desktop Control](https://miosa.ai/docs/computers/desktop) — 28 methods for driving a Computer's desktop — screenshot, click, type, scroll, drag, keyboard, clipboard, windows, shell, and more. - [Embedding & Streaming](https://miosa.ai/docs/computers/embedding) — Embed a live Computer desktop in your own UI via KasmVNC. Pixel streaming, input forwarding. - [Computers (Desktop)](https://miosa.ai/docs/computers/overview) — Full Linux desktops in the cloud — Xfce, Firefox, terminal — controlled via 28 Python SDK methods including screenshot, click, type, scroll, clipboard, windows, shell, and more. - [Core Concepts](https://miosa.ai/docs/concepts) — The canonical architecture reference for MIOSA — six concrete primitives, how they compose into deployments, data services, desktop Computers, and the white-label tenancy model. - [Cookbook](https://miosa.ai/docs/cookbook) — End-to-end recipes — copy-paste-runnable walkthroughs that showcase the MIOSA platform. - [Agent builds an app](https://miosa.ai/docs/cookbook/agent-builds-app) — Your AI agent receives a prompt, writes code into a sandbox, builds it, and publishes a deployed Next.js app — all from a single prompt. - [Browser agent](https://miosa.ai/docs/cookbook/browser-agent) — Boot a full Linux desktop Computer, screenshot a website, click a button, fill a form, take another screenshot — the complete screenshot → action → screenshot loop with your own LLM. - [Multi-tenant SaaS](https://miosa.ai/docs/cookbook/multi-tenant-saas) — Embed MIOSA into your SaaS — tag sandboxes per tenant, query usage per workspace, and issue browser tokens so customers interact directly with their sandboxes. - [Snapshot & fork](https://miosa.ai/docs/cookbook/snapshot-and-fork) — Checkpoint a long-running task, fork into multiple branches to compare outcomes, and restore to a known-good state on failure. - [Streaming code execution](https://miosa.ai/docs/cookbook/streaming-code-execution) — Run a long Python script in a sandbox and stream stdout to your UI in real time via SSE, with backpressure handling. - [Auth-as-a-Service](https://miosa.ai/docs/data/auth) — Per-project user signup, login, and JWT issuance. AUTH_URL and AUTH_JWT_SECRET injected at boot. - [Data](https://miosa.ai/docs/data/overview) — Managed Postgres, Redis, object storage, auth, and volumes — provisioned per project, injected as env vars. - [Postgres](https://miosa.ai/docs/data/postgres) — Managed Postgres per project. PgBouncer-pooled, automatically backed up, injected as DATABASE_URL. - [Redis / Cache](https://miosa.ai/docs/data/redis) — Managed Redis per project for caching, sessions, and pub/sub. - [Storage / Buckets](https://miosa.ai/docs/data/storage) — Per-project object storage with signed-URL uploads and downloads. - [Volumes](https://miosa.ai/docs/data/volumes) — Persistent block storage attached to a runtime instance. State that doesn't fit in Postgres. - [Domains](https://miosa.ai/docs/deploy/domains) — Managed *.miosa.app URLs and custom domains. DNS verification, automatic TLS, instant repointing. - [Environments](https://miosa.ai/docs/deploy/environments) — Production, staging, preview/ — variable and secret scoping for deployments. - [Deploy](https://miosa.ai/docs/deploy/overview) — Turn a sandbox into a stable production URL with immutable history and instant rollback. - [Publishing](https://miosa.ai/docs/deploy/publishing) — Turn a Sandbox into an immutable Deployment Version. Source snapshots, builder VMs, build modes. - [Releases](https://miosa.ai/docs/deploy/releases) — The immutable build artifact — static tarball or dynamic rootfs / OCI image, sha256-keyed. - [Rollback](https://miosa.ai/docs/deploy/rollback) — Repoint a deployment at an older version. Seconds, no rebuild. - [Runtime Instances](https://miosa.ai/docs/deploy/runtime-instances) — Dynamic deployments — Firecracker microVMs booted from a release on the compute fleet. - [Versions](https://miosa.ai/docs/deploy/versions) — Immutable history of every publish. Inspect, promote, archive. - [Files & Exec](https://miosa.ai/docs/develop/files-and-exec) — Read, write, watch files inside a sandbox. Run commands, stream stdout/stderr, manage processes. - [Previews](https://miosa.ai/docs/develop/previews) — Live URLs that proxy into a sandbox port. Public, private, embeddable, share-tokenized. - [Sandboxes](https://miosa.ai/docs/develop/sandboxes) — Mutable Firecracker microVMs for AI agent code execution. Boot in ~150 ms, run commands, expose ports as live preview URLs, snapshot state for branching or rollback. - [Templates](https://miosa.ai/docs/develop/templates) — Pre-built Firecracker images for every major language and framework. Pick the closest match to your stack. - [Fundamental Concepts](https://miosa.ai/docs/fundamentals) — The mental model every MIOSA integrator needs — workspace, authentication, resources, attribution, idempotency, rate limits, errors, and events. - [Integrating an AI agent](https://miosa.ai/docs/guides/agent) — How to bring your own AI agent and drive MIOSA Sandbox or Computer primitives to build, run, and deploy applications autonomously. - [MCP server](https://miosa.ai/docs/guides/mcp) — Install and configure the MIOSA MCP server to drive sandboxes and computers from Claude Code, Cursor, Windsurf, and any other MCP-compatible client. - [Known Limitations](https://miosa.ai/docs/known-limitations) — An honest list of what doesn't work yet, what's in progress, and what's intentionally out of scope. Updated continuously. - [API Keys](https://miosa.ai/docs/platform/api-keys) — Workspace API keys — the one credential your backend uses for every MIOSA call. - [Resource Ownership and Attribution](https://miosa.ai/docs/platform/attribution) — Scope resources to MIOSA workspaces and projects while preserving your own workspace / user / project IDs for billing and reconciliation. - [Browser Tokens](https://miosa.ai/docs/platform/browser-tokens) — Short-lived scoped credentials your backend mints for end-user-facing access. Never expose `msk_*` to the browser. - [Platform / White-label](https://miosa.ai/docs/platform/overview) — Build your own AI app builder on top of MIOSA with organization, workspace, project, resource ownership, custom domains, and short-lived browser tokens. - [Usage & Billing](https://miosa.ai/docs/platform/usage-and-billing) — Track MIOSA usage per workspace, per project, per external customer, and per user. Chargeback to your customers. - [White-label setup](https://miosa.ai/docs/platform/white-label) — Configure organization slug, workspace/project ownership, preview domains, deployment domains, branding, and resource attribution. - [Quickstart](https://miosa.ai/docs/quickstart) — A five-minute hands-on tour of MIOSA — create a sandbox, write code, preview it live, and publish to production. Two tracks: static deploy and agent-driven build. - [Elixir SDK](https://miosa.ai/docs/sdks/elixir) — Install, configure, and make your first request with the MIOSA Elixir SDK. - [Go SDK](https://miosa.ai/docs/sdks/go) — Install, configure, and make your first request with the MIOSA Go SDK. - [Java SDK](https://miosa.ai/docs/sdks/java) — Install, configure, and make your first request with the MIOSA Java SDK. - [Python SDK](https://miosa.ai/docs/sdks/python) — Install, configure, and make your first request with the MIOSA Python SDK. - [TypeScript SDK](https://miosa.ai/docs/sdks/typescript) — Install, configure, and make your first request with the MIOSA TypeScript SDK. ## Machine-Readable Artifacts - [OpenAPI YAML](https://miosa.ai/openapi.yaml) - [Docs index JSON](https://miosa.ai/docs-index.json) - [Full docs text](https://miosa.ai/llms-full.txt) - [XML sitemap](https://miosa.ai/sitemap.xml)