Find a template by ID

Returns a single template. Use this API reference to review authentication, request parameters, response fields, and errors for this Runpod operation.

GET /templates/{templateId}

Find a template by ID

cURL

curl --request GET \
  --url https://rest.runpod.io/v1/templates/{templateId} \
  --header 'Authorization: Bearer <token>'

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

templateId · string · required

ID of template to return.

Query Parameters

includeEndpointBoundTemplates · boolean · default: false

Include templates bound to Serverless endpoints in the response.

Example:

true

includePublicTemplates · boolean · default: false

Include community-made public templates in the response.

Example:

true

includeRunpodTemplates · boolean · default: false

Include official Runpod templates in the response.

Example:

true

Response

200

application/json

Successful operation.

category · string

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

Example:

"NVIDIA"

containerDiskInGb · integer

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.

Example:

50

containerRegistryAuthId · string

dockerEntrypoint · string[]

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

Example:

[]

dockerStartCmd · string[]

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.

Example:

[]

earned · number

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

Example:

100

env · object

Example:

{ "ENV_VAR": "value" }

id · string

A unique string identifying a template.

Example:

"30zmvf89kd"

imageName · string

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

Example:

"runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04"

isPublic · boolean

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.

Example:

false

isRunpod · boolean

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

Example:

true

isServerless · boolean

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

Example:

true

name · string

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

Example:

"my template"

ports · string[]

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.

Example:

["8888/http", "22/tcp"]

readme · string

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

runtimeInMin · integer

volumeInGb · integer

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.

Example:

20

volumeMountPath · string

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:

"/workspace"