On this page

Sandbox templates are pre-built images with toolchains, dependencies, and configuration baked in. Launching from a template is faster than installing packages at runtime and ensures reproducible environments.


Endpoints

MethodPathDescription
GET/api/v1/sandbox-templatesList available templates
GET/api/v1/sandbox-templates/{id}Get a specific template
POST/api/v1/sandboxesCreate sandbox from a template (via template_id)

List Templates

GET /api/v1/sandbox-templates

Returns all templates available to your tenant, including official MIOSA templates and any custom templates you have built.

Auth

Authorization: Bearer msk_...

Response - 200 OK

{
  "data": [
    {
      "id": "tpl_debian12",
      "name": "Debian 12 (Bookworm)",
      "slug": "debian-12-sandbox-v8",
      "description": "Debian Bookworm with Node 20, Python 3.11, Go 1.22, and Rust 1.78 pre-installed.",
      "tags": ["debian", "node", "python", "go", "official"],
      "memory_mb": 4096,
      "vcpus": 2,
      "created_at": "2026-05-11T00:00:00Z",
      "is_official": true
    },
    {
      "id": "tpl_nextjs",
      "name": "Next.js 14",
      "slug": "nextjs-14",
      "description": "Next.js 14 App Router starter with Tailwind CSS.",
      "tags": ["nextjs", "react", "typescript"],
      "memory_mb": 4096,
      "vcpus": 2,
      "created_at": "2026-04-01T00:00:00Z",
      "is_official": true
    }
  ]
}
FieldTypeDescription
idstringTemplate ID
namestringHuman-readable template name
slugstringShort identifier used in the image field
descriptionstringWhat is pre-installed
tagsstring[]Searchable tags
memory_mbintegerDefault sandbox memory allocation
vcpusintegerDefault vCPU count
is_officialbooleanMIOSA-maintained template

Get Template

GET /api/v1/sandbox-templates/{id}

Returns a single template by ID.

Response - 200 OK

Same shape as a single item from the list response.


Create Sandbox from Template

Use the standard sandbox creation endpoint with the template slug as the image field:

POST /api/v1/sandboxes

{
  "image": "debian-12-sandbox-v8",
  "memory_mb": 4096,
  "vcpus": 2
}

See the Sandboxes API for the full sandbox creation reference.


Errors

StatusCodeCause
404not_foundTemplate ID does not exist

Examples

Was this helpful?