Skip to main content
POST
Create a template and kick off the first build

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required

Human-readable name, unique per team. Used as the from_template value when creating sandboxes. Lowercase letters, digits, and . _ / - only; must start and end with a letter or digit. Names starting with superserve/ are reserved for curated system templates and rejected for team-owned templates.

Required string length: 1 - 128
Pattern: ^[a-z0-9]([a-z0-9._/-]*[a-z0-9])?$
Example:

"my-python-env"

build_spec
object
required

Declaration of how to build a template.

vcpu
integer
default:1
Required range: 1 <= x <= 10
memory_mib
integer
default:1024
Required range: 256 <= x <= 20480
disk_mib
integer
default:4096
Required range: 1024 <= x <= 30720

Response

Template created; first build queued

Returned by POST /templates — includes both the new template id and the id of the first build that was queued for it. Clients can immediately open the build-log SSE stream or poll the template for status transitions.

id
string<uuid>
team_id
string<uuid>
name
string
status
enum<string>
Available options:
building,
ready,
failed
vcpu
integer
memory_mib
integer
disk_mib
integer
created_at
string<date-time>
build_id
string<uuid>

ID of the first build. Use it to stream logs or poll status.