API reference · Schema
PodConfig
imagestringrequiredContainer image reference
hardwareobjectrequiredSKU and number of GPUs the pod runs on
ShowHide 2 fields of
hardwareskustringrequiredHardware type code
gpu_countintegerrequiredNumber of GPUs
regionstringrequiredRegion code
pricing_classstringrequired`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_gbintegerrequiredWritable container disk in GB; reset whenever the container is recreated (stop, reconfigure)
volumeobject | nullrequiredThe pod’s own volume and where it is mounted; null for none
ShowHide 2 fields of
volumevolume_idstringrequiredID of the volume
mount_pathstringrequiredAbsolute path the volume is mounted at inside the container
network_volumesarray of objectrequiredNetwork volumes the pod mounts
ShowHide 3 fields of
network_volumesvolume_idstringrequiredID of the volume
mount_pathstringrequiredAbsolute path the volume is mounted at inside the container
read_onlybooleanrequiredMounted read-only
portsarray of objectrequiredExposed container ports
ShowHide 4 fields of
portsportintegerrequiredPort number the container listens on
protocolstringrequired`http`: served at the port’s HTTPS URL (WebSocket included). `tcp`: raw TCP, reachable through SSH port forwarding.
One of
httptcpvisibilitystringrequired`public`: anyone with the URL. `private`: no URL; SSH port forwarding and the project network only.
One of
publicprivatenamestringrequiredIts name
envarray of objectrequiredPlain environment variables
ShowHide 2 fields of
envnamestringrequiredIts name
valuestringrequiredValue of the variable
secret_envarray of objectrequiredEnvironment variables taken from project secrets (values are never shown)
ShowHide 2 fields of
secret_envnamestringrequiredIts name
secret_idstringrequiredID of the secret
commandarray of stringrequiredReplaces the image’s entrypoint when non-empty
argsarray of stringrequiredReplaces the image’s default arguments when non-empty
registry_credential_idstring | nullrequiredID of the registry credential
sshbooleanrequiredAllow SSH (and SFTP, port forwarding) with the project’s SSH keys
Models mounted read-only from the host’s model cache
ShowHide 1 field of
modelsreference_idstringrequiredThe model reference mounted
{
"image": "string",
"hardware": {
"sku": "string",
"gpu_count": 1
},
"region": "string",
"pricing_class": "on_demand",
"container_disk_gb": 1,
"volume": {
"volume_id": "string",
"mount_path": "string"
},
"network_volumes": [
{
"volume_id": "string",
"mount_path": "string",
"read_only": true
}
],
"ports": [
{
"port": 1,
"protocol": "http",
"visibility": "public",
"name": "string"
}
],
"env": [
{
"name": "string",
"value": "string"
}
],
"secret_env": [
{
"name": "string",
"secret_id": "string"
}
],
"command": [
"string"
],
"args": [
"string"
],
"registry_credential_id": "string",
"ssh": true,
"models": [
{
"reference_id": "string"
}
]
}