# 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, deploy, and operate AI-generated applications on managed compute. - [Agent Development Kit (ADK)](https://miosa.ai/docs/adk) - Build LLM agents that use MIOSA sandboxes, desktops, and deploys with the tool-call loop already wired. TypeScript ADK first; Python next. - [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. - [Audit Log API](https://miosa.ai/docs/api-reference/audit-log) - Retrieve a cursor-paginated audit log of all actions taken within your tenant. - [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. - [Egress (Security) API](https://miosa.ai/docs/api-reference/egress) - API reference for the MIOSA Egress credential vault, network allowlist, OAuth Connect, and audit log. - [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. - [Invites API](https://miosa.ai/docs/api-reference/invites) - API reference for the workspace invite and org invite flows - send, list, revoke, preview, and accept email invitations. - [Workspace Members API](https://miosa.ai/docs/api-reference/members) - API reference for managing workspace member rosters - add, remove, and update roles for users inside a workspace. - [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. - [Preview Tokens API](https://miosa.ai/docs/api-reference/preview-tokens) - Generate short-lived signed tokens for iframe embedding without exposing an API key. - [Projects API](https://miosa.ai/docs/api-reference/projects) - API reference for creating and managing projects inside MIOSA workspaces. - [Quotas API](https://miosa.ai/docs/api-reference/quotas) - Set per-end-user resource limits for white-label multi-tenant deployments. - [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. - [Sandbox Env API](https://miosa.ai/docs/api-reference/sandbox-env) - CRUD for per-sandbox environment variables, encrypted at rest. - [Sandbox Files (Advanced) API](https://miosa.ai/docs/api-reference/sandbox-files-advanced) - File tree traversal, batch write, and SSE file-watch for IDE-grade sandbox file operations. - [Sandbox Processes API](https://miosa.ai/docs/api-reference/sandbox-processes) - Start, monitor, and stream logs for long-running background processes inside sandboxes. - [Sandbox Shares API](https://miosa.ai/docs/api-reference/sandbox-shares) - Create and manage public share URLs for sandboxes. - [Sandbox Templates API](https://miosa.ai/docs/api-reference/sandbox-templates) - Browse the template marketplace and launch sandboxes from pre-built images. - [Sandboxes API](https://miosa.ai/docs/api-reference/sandboxes) - API reference for creating, managing, and executing code in MIOSA sandboxes - ephemeral isolated 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 microVM 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. - [Tenant Branding API](https://miosa.ai/docs/api-reference/tenant-branding) - Customize the logo, name, and colors shown on sandbox 404 and 502 error pages. - [Tenant Events (SSE) API](https://miosa.ai/docs/api-reference/tenant-events) - Subscribe to a real-time server-sent event stream of all tenant-wide platform events. - [Tenant Preview Domain API](https://miosa.ai/docs/api-reference/tenant-preview-domain) - Configure a custom apex domain for sandbox preview URLs (white-label). - [Usage Rollup API](https://miosa.ai/docs/api-reference/usage-rollup) - Aggregate sandbox compute usage and spend by external user, project, or workspace. - [API Reference / Versions](https://miosa.ai/docs/api-reference/versions) - Immutable deployment version sub-resource. List, get, promote, archive. - [Webhooks API](https://miosa.ai/docs/api-reference/webhooks) - Subscribe to platform lifecycle events via outgoing HTTP callbacks with HMAC signature verification. - [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. - [Benchmarks](https://miosa.ai/docs/benchmarks) - MIOSA sandbox benchmark results, competitive provider comparison, and capability matrix. - [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 with a short-lived stream URL. Pixel streaming and input forwarding are handled by MIOSA. - [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 product model for MIOSA - sandboxes, previews, deployments, versions, domains, data services, desktop Computers, and white-label tenancy. - [Cookbook](https://miosa.ai/docs/cookbook) - End-to-end recipes for app builders, white-label SaaS, lead magnets, code execution, browser agents, previews, and production deploys. - [Agent builds an app](https://miosa.ai/docs/cookbook/agent-builds-app) - Your AI agent receives a prompt, writes code into a sandbox, iterates visually with live preview, checkpoints progress, branches experiments, shares with stakeholders, and publishes to production. - [Agent with secrets - full walkthrough](https://miosa.ai/docs/cookbook/agent-with-secrets) - Create a sandbox, store an OpenAI key and connect GitHub via OAuth, run an AI agent, watch the audit log live, lock the network down, then rotate the key mid-run. - [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. - [Embed sandbox in an iframe](https://miosa.ai/docs/cookbook/embed-sandbox-iframe) - Your server mints a preview token; your frontend uses it as an iframe src. Covers React, Vue, Svelte, and vanilla JS, plus token TTL refresh. - [Lockdown workflow - audit to enforce](https://miosa.ai/docs/cookbook/lockdown-workflow) - Operational playbook for moving a sandbox from audit-only to locked-down network policy. Start safe, review suggestions, lock down, handle pending requests, roll back if needed. - [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. - [Per-user quotas and billing](https://miosa.ai/docs/cookbook/per-user-quotas-billing) - Set per-end-user resource caps, pull monthly usage rollups keyed by external_user_id, and generate invoices for your customers. - [Sandbox events in real time](https://miosa.ai/docs/cookbook/sandbox-events-realtime) - React to sandbox lifecycle events using either HMAC-signed webhooks (server-to-server) or the SSE event stream (in-process). Covers both patterns, idempotency, and when to choose each. - [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. - [White-label end-users - secrets, audit, OAuth branding](https://miosa.ai/docs/cookbook/white-label-end-users) - Stamp external_user_id on sandboxes, scope credentials per end-user, surface per-user audit data in your own dashboard, and brand the OAuth consent flow with your domain. - [Custom Domains](https://miosa.ai/docs/custom-domains) - [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. - [Deployment Domains](https://miosa.ai/docs/deploy/domains) - Preview domains, tenant deployment domains, managed fallback URLs, exact custom domains, DNS verification, automatic TLS, and route changes. - [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 versions, health checks, deployment domains, custom domains, and rollback. - [Publishing](https://miosa.ai/docs/deploy/publishing) - Turn a Sandbox into an immutable Deployment Version. Source snapshots, build modes, static artifacts, dynamic runtimes, and public URLs. - [Releases](https://miosa.ai/docs/deploy/releases) - The immutable build artifact - static files or dynamic server artifact, sha256-keyed. - [Rollback](https://miosa.ai/docs/deploy/rollback) - Repoint a deployment at an older version. Seconds, no rebuild. - [Dynamic Runtimes](https://miosa.ai/docs/deploy/runtime-instances) - Dynamic deployments - production runtimes started from a release, health-checked, and reconciled by MIOSA. - [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 isolated environments for AI agent code execution. Run commands, edit files, expose ports as live preview URLs, snapshot state, and publish to production. - [Templates](https://miosa.ai/docs/develop/templates) - Pre-built template images for every major language and framework. Pick the closest match to your stack. - [Evaluations](https://miosa.ai/docs/evaluations) - Measure sandbox, desktop, and agent workflows with reproducible tasks, traces, and desktop-readiness benchmarks. - [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) - Connect any AI agent to MIOSA's 145-tool MCP server - hosted (zero install) or local. Drive sandboxes, computers, deployments, databases, storage, and more from Claude Code, Cursor, Windsurf, or your own agent loop. - [Claude Code Skills](https://miosa.ai/docs/guides/skills) - [Integrations - Build Your Own Product on MIOSA](https://miosa.ai/docs/integrations) - Ship a white-label SaaS where your end-users never see the MIOSA brand. Isolated compute, custom domains, branded previews, usage rollup, and webhooks - all under your domain. - [Compute Provider Comparison](https://miosa.ai/docs/integrations/comparison) - How MIOSA compares to Orgo, AgentComputer, E2B, Daytona, and ascii Box on pricing, capabilities, and desktop/boot performance. Public data as of 2026-06-09. - [Example Apps](https://miosa.ai/docs/integrations/examples) - Four full-stack white-label examples you can clone, run locally, and adapt to your own stack. - [External Compute Providers](https://miosa.ai/docs/integrations/external-computers) - Connect third-party computer providers to MIOSA while keeping one product API, one billing model, and one user experience. - [Preview Tokens](https://miosa.ai/docs/integrations/preview-tokens) - Mint short-lived server-side tokens to embed sandbox previews in iframes without exposing your API key to the browser. - [Webhooks](https://miosa.ai/docs/integrations/webhooks) - Subscribe to sandbox and deployment lifecycle events, verify HMAC-SHA256 signatures, handle retries, and test locally. - [White-Label SaaS - End-to-End Walkthrough](https://miosa.ai/docs/integrations/whitelabel-saas) - Build a product like OpenDesigns.ai on MIOSA. Per-user sandboxes, custom domains, iframe embeds, webhooks, usage billing, and quota controls - all from scratch to production. - [Availability & Roadmap](https://miosa.ai/docs/known-limitations) - Current MIOSA product availability, what is generally available, what is in hardening, and what is planned next. - [MCP Server](https://miosa.ai/docs/mcp) - Connect Claude Code, Cursor, Gemini CLI, OpenCode, or any MCP-aware AI client to MIOSA. One-command install, browser-based auth, sandbox + desktop + deploy tools. - [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. - [Custom Preview Domains](https://miosa.ai/docs/platform/custom-domains) - Serve your sandboxes and computers at . instead of .miosa.app - one CNAME record, zero dashboard configuration. - [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. - [Egress SDK reference](https://miosa.ai/docs/sdks/egress) - Every Secrets, Connect Accounts, Network Allowlist, and Audit Log SDK method across Python, TypeScript, Go, Java, and Elixir - side by side. - [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. - [Security](https://miosa.ai/docs/security) - Built-in credential vault, outbound network controls, and audit log on every MIOSA sandbox and computer. No setup. Free on all plans. - [Audit Log](https://miosa.ai/docs/security/audit-log) - Every outbound call your sandbox makes is logged. Live-tail, filter, export. - [Connect Accounts (OAuth)](https://miosa.ai/docs/security/connect-accounts) - Authorize accounts (GitHub, Google, Slack, …) once. MIOSA manages token refresh; your sandbox sees an env var. - [Network Allowlist](https://miosa.ai/docs/security/network) - Watch what your sandbox calls. When you're ready, lock it down with a one-click allowlist. Reversible. - [Secrets - Quickstart](https://miosa.ai/docs/security/secrets) - Store API keys in MIOSA. Your sandbox uses an opaque placeholder. The real key never lives inside the VM. - [Security - Troubleshooting](https://miosa.ai/docs/security/troubleshooting) - Top 15 issues across MIOSA Secrets, Connect Accounts, Network Allowlist, Audit Log, and White-label Credentials - with root causes and fixes. - [White-label Credentials](https://miosa.ai/docs/security/white-label) - How to scope secrets and OAuth connections to your own end-users on top of MIOSA - with your branding, not ours. - [UI Components](https://miosa.ai/docs/ui-components) - Drop-in React, Vue, and Svelte components for embedding MIOSA sandboxes in your own frontend. - [React UI Components](https://miosa.ai/docs/ui-components/react) - Drop-in React components for embedding MIOSA sandboxes - MiosaPreview, MiosaTerminal, MiosaFileTree, MiosaUsage. - [Svelte UI Components](https://miosa.ai/docs/ui-components/svelte) - Drop-in Svelte 5 components for embedding MIOSA sandboxes - MiosaPreview, MiosaTerminal, MiosaFileTree, MiosaUsage. - [Vue UI Components](https://miosa.ai/docs/ui-components/vue) - Drop-in Vue 3 components for embedding MIOSA sandboxes - MiosaPreview, MiosaTerminal, MiosaFileTree, MiosaUsage. ## 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)