API reference · Schema
CreateTemplateRequest
namestringrequiredIts name
1–100 characters
descriptionstring | nullFree-text description
up to 1000 characters
imagestringrequiredContainer image reference
1–512 characters
visibilitystring`private`: every project of your organization can use it. `public`: every organization can; secret references and the registry credential are dropped.
One of
privatepublicdefault "private"
requires_gpubooleanPods from it need a GPU SKU (default false)
readmestring | nullUsage notes shown with the template (Markdown)
up to 20000 characters
registry_credential_idstring | nullID of the registry credential
ID with prefix rcr_
defaultsobjectLaunch defaults; fields left out take their default values
ShowHide 9 fields of
defaultscommandarray of stringReplaces the image’s entrypoint when non-empty
up to 64 items · default []
argsarray of stringReplaces the image’s default arguments when non-empty
up to 256 items · default []
envarray of objectValues may contain {{random_token}}, replaced with a fresh random token for each pod
up to 128 items · default []
ShowHide 2 fields of
envnamestringrequiredIts name
pattern ^[A-Za-z_][A-Za-z0-9_]{0,127}$
valuestringrequiredValue of the variable (up to 32,768 characters)
up to 32768 characters
secret_envarray of objectPrivate templates only; dropped from public ones
up to 128 items · default []
ShowHide 2 fields of
secret_envnamestringrequiredIts name
pattern ^[A-Za-z_][A-Za-z0-9_]{0,127}$
secret_idstringrequiredID of the secret
ID with prefix sec_
portsarray of objectContainer ports each pod exposes
up to 16 items · default []
ShowHide 4 fields of
portsportintegerrequiredPort number the container listens on
1–65535
protocolstring`http`: served at the port’s HTTPS URL (WebSocket included). `tcp`: raw TCP, reachable through SSH port forwarding.
One of
httptcpdefault "http"
visibilitystring`public`: anyone with the URL. `private`: no URL; SSH port forwarding and the project network only.
One of
publicprivatedefault "public"
namestringIts name
pattern ^[a-z][a-z0-9-]{0,30}$
container_disk_gbintegerWritable container disk in GB for each pod
5–500 · default 20
volumeobject | nullPod volume created with each pod (null: none)
default null
ShowHide 2 fields of
volumesize_gbintegerrequiredSize in GB
1–2000
mount_pathstringrequiredAbsolute path the volume is mounted at inside the container
2–256 characters
sshbooleanAllow SSH (and SFTP, port forwarding) with the project’s SSH keys
default true
categorystringGrouping shown in the catalog: `base`, `notebook`, `ml` or `other`
One of
basenotebookmlotherdefault "other"
{
"name": "Team base image",
"image": "ubuntu:26.04",
"visibility": "private",
"defaults": {
"command": [
"sleep",
"infinity"
],
"volume": {
"size_gb": 20,
"mount_path": "/workspace"
}
}
}Used by
- Create a private (organization) or public template
POST /v1/templates