v1

latestOpenAPI 3.0.32026-07-133733150.4 KB

templates

Create a new template

Create a new template.

post/templates

Request body

category'NVIDIA' | 'AMD' | 'CPU'

The compute category of the resource defined by this template.

containerDiskInGbinteger

The amount of disk space in GB to allocate for the container.

containerRegistryAuthIdstring

The unique string representing the container auth object needed for a private image.

dockerEntrypointstring[]

If specified, overrides the ENTRYPOINT for the Docker image run on the Pods using this template. If [], uses the ENTRYPOINT defined in the DockerFile.

dockerStartCmdstring[]

If specified, overrides the start CMD for the Docker image run on the Pods using this template. If [], uses the start CMD defined in the DockerFile.

envobject

imageNamestring required

Docker image name.

isPublicboolean

If this is a Pod template, specifies whether the template is visible to other Runpod users.

isServerlessboolean

Whether the template specifies a Serverless worker or a Pod.

namestring required

Template name.

portsstring[]

A list of ports exposed on the created Pod. Each port is formatted as [port number]/[protocol]. Protocol can be either http or tcp.

readmestring

README content in markdown format.

volumeInGbinteger

The amount of disk space, in gigabytes (GB), to allocate on the Pods deployed with this template.

volumeMountPathstring

If a volume is attached to a Pod deployed with this template, the absolute path where the volume will be mounted in the filesystem.

Example request

{
  "env": {
    "ENV_VAR": "value"
  },
  "ports": [
    "8888/http",
    "22/tcp"
  ]
}

Response

Successful operation.

categorystring

The category of the template. The category can be used to filter templates in the Runpod UI. Current categories are NVIDIA, AMD, and CPU.

containerDiskInGbinteger

The amount of disk space, in gigabytes (GB), to allocate on the container disk for a Pod or worker. The data on the container disk is wiped when the Pod or worker restarts. To persist data across restarts, set volumeInGb to configure the local network volume.

containerRegistryAuthIdstring

dockerEntrypointstring[]

If specified, overrides the ENTRYPOINT for the Docker image run on a Pod or worker. If [], uses the ENTRYPOINT defined in the image.

dockerStartCmdstring[]

If specified, overrides the start CMD for the Docker image run on a Pod or worker. If [], uses the start CMD defined in the image.

earnednumber

The amount of Runpod credits earned by the creator of a template by all Pods or workers created from the template.

envobject

idstring

A unique string identifying a template.

imageNamestring

The image tag for the container run on Pods or workers created from a template.

isPublicboolean

Set to true if a template is public and can be used by any Runpod user. Set to false if a template is private and can only be used by the creator.

isRunpodboolean

If true, a template is an official template managed by Runpod.

isServerlessboolean

If true, instances created from a template are Serverless workers. If false, instances created from a template are Pods.

namestring

A user-defined name for a template. The name needs to be unique.

portsstring[]

A list of ports exposed on a Pod or worker. Each port is formatted as [port number]/[protocol]. Protocol can be either http or tcp.

readmestring

A string of markdown-formatted text that describes a template. The readme is displayed in the Runpod UI when a user selects the template.

runtimeInMininteger

volumeInGbinteger

The amount of disk space, in gigabytes (GB), to allocate on the local network volume for a Pod or worker. The data on the local network volume is persisted across restarts. To persist data so that future Pods and workers can access it, create a network volume and set networkVolumeId to attach it to the Pod or worker.

volumeMountPathstring

If a local network volume or network volume is attached to a Pod or worker, the absolute path where the network volume is mounted in the filesystem.

Example response

{
  "category": "NVIDIA",
  "containerDiskInGb": 50,
  "dockerEntrypoint": [],
  "dockerStartCmd": [],
  "earned": 100,
  "env": {
    "ENV_VAR": "value"
  },
  "id": "30zmvf89kd",
  "imageName": "runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04",
  "isRunpod": true,
  "isServerless": true,
  "name": "my template",
  "ports": [
    "8888/http",
    "22/tcp"
  ],
  "volumeInGb": 20,
  "volumeMountPath": "/workspace"
}