Sign in

v1

latestOpenAPI 3.1.02026-07-2676123203.9 KB
Templates

Get a template

Returns the full configuration of a single template by ID.

get/v2/templates/{id}

Response

OK

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"
}