Skip to main content
GET
https://api.novita.ai
/
gpu-instance
/
openapi
/
v1
/
template
Get Template
curl --request GET \
  --url https://api.novita.ai/gpu-instance/openapi/v1/template \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
{
  "template": {
    "Id": "<string>",
    "name": "<string>",
    "readme": "<string>",
    "type": "<string>",
    "channel": "<string>",
    "image": "<string>",
    "imageAuth": "<string>",
    "startCommand": "<string>",
    "entrypoint": "<string>",
    "rootfsSize": 123,
    "ports": [
      {
        "type": "<string>",
        "ports": {}
      }
    ],
    "envs": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "tools": [
      {
        "name": "<string>",
        "describe": "<string>",
        "port": 123,
        "type": "<string>"
      }
    ],
    "createdAt": "<string>",
    "recommendCards": [
      {
        "gpuSpecId": "<string>",
        "cardNum": "<string>"
      }
    ],
    "minCudaVersion": "<string>"
  }
}

​
Request Headers

​
Content-Type
string
required
Enum: application/json
​
Authorization
string
required
Bearer authentication format, for example: Bearer {{API Key}}.

​
Query Parameters

​
templateId
string
required
ID of the template being queried.

​
Response

​
template
object
Template settings.

​
Example

Request 
curl --request GET \
  --url 'https://api.novita.ai/gpu-instance/openapi/v1/template' \
  --header 'Authorization: Bearer {{API Key}}'
Response 
{
  "template": {
    "Id": "212",
    "name": "ubuntu",
    "readme": "readme",
    "type": "instance",
    "channel": "private",
    "image": "ubuntu:latest",
    "imageAuth": "",
    "startCommand": "",
    "entrypoint": "",
    "rootfsSize": 10,
    "ports": [
      {
        "type": "tcp",
        "ports": [8080, 8090]
      },
      {
        "type": "http",
        "ports": [6000, 60001]
      }
    ],
    "envs": [
      {
        "key": "testkey",
        "value": "123"
      }
    ],
    "tools": [
      {
        "name": "Jupyter",
        "describe": "Start Jupyter Notebook",
        "port": 8888,
        "type": "http"
      }
    ],
    "createdAt": "1713162260",
    "recommendCards": [
      {
        "gpuSpecId": "4090.18c.60g",
        "cardNum": "2"
      }
    ],
    "minCudaVersion": "11.8"
  }
}