API reference · Schema
CreatePodRequest
namestringrequiredIts name
1–100 characters
hostnamestringName in the project’s private network (default: from the name)
pattern ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
template_idstringID of the template
ID with prefix tpl_
imagestringImage reference; defaults to the template’s
1–512 characters
ShowHide 2 fields of
hardwareskustringrequiredHardware type code
1–64 characters
gpu_countintegerNumber of GPUs
0–8 · default 0
regionstringrequiredRegion code
1–64 characters
pricing_classstring`interruptible` costs less and may be stopped (preempted) when on-demand work needs the capacity; it then waits in the queue to run again. On-demand pods are never preempted.
One of
on_demandinterruptiblecontainer_disk_gbintegerWritable container disk; reset whenever the container is recreated (stop, reconfigure). Default 20.
5–500
network_volumesarray of NetworkVolumeMountNetwork volumes to mount. A pod that mounts a volume runs on the host the volume is pinned to.
up to 4 items
ShowHide 3 fields of
network_volumesvolume_idstringrequiredID of the volume
ID with prefix vol_
mount_pathstringrequiredAbsolute path the volume is mounted at inside the container
2–256 characters
read_onlybooleanMount the volume read-only in this pod
default false
portsarray of PodPortContainer ports to expose; each public HTTP port gets its own HTTPS URL
up to 16 items
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}$
envarray of objectPlain environment variables. Names starting with POD_, NVIDIA_ or LD_ are reserved.
up to 128 items
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 objectEnvironment variables whose values come from project secrets, read when the container is created.
up to 128 items
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_
commandarray of stringReplaces the image’s entrypoint when non-empty
up to 64 items
argsarray of stringReplaces the image’s default arguments when non-empty
up to 256 items
registry_credential_idstring | nullID of the registry credential
ID with prefix rcr_
sshbooleanAllow SSH (and SFTP, port forwarding) with the project’s SSH keys
modelsarray of PodModelMountModels from the model hub, cached on the host and mounted read-only at /model-cache/models--<owner>--<name> (HF_HUB_CACHE points there unless env sets it). Changing them recreates the container.
up to 8 items
ShowHide 1 field of
modelsreference_idstringrequiredA model reference of this project (POST /v1/model-references)
ID with prefix mrf_
volumeNewPodVolume | ExistingPodVolume | any JSON | nullThe pod’s own persistent volume (default: the template’s; null for none). It survives stops and reconfiguration and is deleted on terminate unless kept.
{
"name": "notebook",
"image": "quay.io/jupyter/base-notebook:2026-11-10",
"hardware": {
"sku": "cpu-2c-4gb",
"gpu_count": 0
},
"region": "dev-local-1",
"volume": {
"size_gb": 10,
"mount_path": "/home/jovyan/work"
},
"ports": [
{
"port": 8888,
"protocol": "http",
"visibility": "public"
}
]
}