API reference · Schema
Template
objectstringrequiredAlways `template`: the type of this object
One of
templateidstringrequiredUnique ID (`tpl_…`)
ID with prefix tpl_
sourcestringrequired`official`: provided by the platform. `public`: shared by an organization with everyone. `private`: your organization’s own.
One of
officialpublicprivateorg_idstring | nullrequiredNull for official templates
namestringrequiredIts name
descriptionstring | nullrequiredFree-text description
imagestringrequiredContainer image reference
requires_gpubooleanrequiredNeeds a GPU SKU (e.g. built on CUDA)
readmestring | nullrequiredUsage notes (Markdown); null when there are none
registry_credential_idstring | nullrequiredID of the registry credential
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"
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
updated_atstring (date-time)requiredWhen it last changed (ISO 8601, UTC)
deleted_atstring (date-time) | nullrequiredWhen it was deleted (null while it exists) (ISO 8601, UTC)
{
"object": "template",
"id": "tpl_01jc5zq4m8k3v6x9t2w7r0b1e4",
"source": "official",
"org_id": "string",
"name": "string",
"description": "string",
"image": "string",
"requires_gpu": true,
"readme": "string",
"registry_credential_id": "string",
"defaults": {
"command": [],
"args": [],
"env": [],
"secret_env": [],
"ports": [],
"container_disk_gb": 20,
"volume": null,
"ssh": true,
"category": "other"
},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"deleted_at": "2026-01-01T00:00:00.000Z"
}Used by
- Save a pod’s configuration as a template (secrets are dropped from public ones)
POST /v1/pods/{pod_id}/templates - Templates you can launch: official, public and your organization’s private ones
GET /v1/templates - Create a private (organization) or public template
POST /v1/templates - Get a template
GET /v1/templates/{template_id} - Update one of your organization’s templates (pods made from it are not changed)
PATCH /v1/templates/{template_id} - Delete one of your organization’s templates (pods made from it keep running)
DELETE /v1/templates/{template_id}