Create GPU Instance

curl --request POST \
  --url https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "name": "<string>",
  "productId": "<string>",
  "gpuNum": 123,
  "rootfsSize": 123,
  "imageUrl": "<string>",
  "imageAuth": "<string>",
  "imageAuthId": "<string>",
  "ports": "<string>",
  "envs": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "tools": [
    {
      "name": "<string>",
      "port": "<string>",
      "type": "<string>"
    }
  ],
  "command": "<string>",
  "entrypoint": "<string>",
  "clusterId": "<string>",
  "networkStorages": [
    {
      "Id": "<string>",
      "mountPoint": "<string>"
    }
  ],
  "networkId": "<string>",
  "kind": "<string>",
  "month": 123,
  "billingMode": "<string>",
  "autoRenew": true,
  "autoRenewMonth": 123,
  "minCudaVersion": "<string>"
}
'

import requests

url = "https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create"

payload = {
    "name": "<string>",
    "productId": "<string>",
    "gpuNum": 123,
    "rootfsSize": 123,
    "imageUrl": "<string>",
    "imageAuth": "<string>",
    "imageAuthId": "<string>",
    "ports": "<string>",
    "envs": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "tools": [
        {
            "name": "<string>",
            "port": "<string>",
            "type": "<string>"
        }
    ],
    "command": "<string>",
    "entrypoint": "<string>",
    "clusterId": "<string>",
    "networkStorages": [
        {
            "Id": "<string>",
            "mountPoint": "<string>"
        }
    ],
    "networkId": "<string>",
    "kind": "<string>",
    "month": 123,
    "billingMode": "<string>",
    "autoRenew": True,
    "autoRenewMonth": 123,
    "minCudaVersion": "<string>"
}
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "<authorization>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
  body: JSON.stringify({
    name: '<string>',
    productId: '<string>',
    gpuNum: 123,
    rootfsSize: 123,
    imageUrl: '<string>',
    imageAuth: '<string>',
    imageAuthId: '<string>',
    ports: '<string>',
    envs: [{key: '<string>', value: '<string>'}],
    tools: [{name: '<string>', port: '<string>', type: '<string>'}],
    command: '<string>',
    entrypoint: '<string>',
    clusterId: '<string>',
    networkStorages: [{Id: '<string>', mountPoint: '<string>'}],
    networkId: '<string>',
    kind: '<string>',
    month: 123,
    billingMode: '<string>',
    autoRenew: true,
    autoRenewMonth: 123,
    minCudaVersion: '<string>'
  })
};

fetch('https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'productId' => '<string>',
    'gpuNum' => 123,
    'rootfsSize' => 123,
    'imageUrl' => '<string>',
    'imageAuth' => '<string>',
    'imageAuthId' => '<string>',
    'ports' => '<string>',
    'envs' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'tools' => [
        [
                'name' => '<string>',
                'port' => '<string>',
                'type' => '<string>'
        ]
    ],
    'command' => '<string>',
    'entrypoint' => '<string>',
    'clusterId' => '<string>',
    'networkStorages' => [
        [
                'Id' => '<string>',
                'mountPoint' => '<string>'
        ]
    ],
    'networkId' => '<string>',
    'kind' => '<string>',
    'month' => 123,
    'billingMode' => '<string>',
    'autoRenew' => true,
    'autoRenewMonth' => 123,
    'minCudaVersion' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"gpuNum\": 123,\n  \"rootfsSize\": 123,\n  \"imageUrl\": \"<string>\",\n  \"imageAuth\": \"<string>\",\n  \"imageAuthId\": \"<string>\",\n  \"ports\": \"<string>\",\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tools\": [\n    {\n      \"name\": \"<string>\",\n      \"port\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"command\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"clusterId\": \"<string>\",\n  \"networkStorages\": [\n    {\n      \"Id\": \"<string>\",\n      \"mountPoint\": \"<string>\"\n    }\n  ],\n  \"networkId\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"month\": 123,\n  \"billingMode\": \"<string>\",\n  \"autoRenew\": true,\n  \"autoRenewMonth\": 123,\n  \"minCudaVersion\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "<authorization>")
  .body("{\n  \"name\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"gpuNum\": 123,\n  \"rootfsSize\": 123,\n  \"imageUrl\": \"<string>\",\n  \"imageAuth\": \"<string>\",\n  \"imageAuthId\": \"<string>\",\n  \"ports\": \"<string>\",\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tools\": [\n    {\n      \"name\": \"<string>\",\n      \"port\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"command\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"clusterId\": \"<string>\",\n  \"networkStorages\": [\n    {\n      \"Id\": \"<string>\",\n      \"mountPoint\": \"<string>\"\n    }\n  ],\n  \"networkId\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"month\": 123,\n  \"billingMode\": \"<string>\",\n  \"autoRenew\": true,\n  \"autoRenewMonth\": 123,\n  \"minCudaVersion\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n  \"name\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"gpuNum\": 123,\n  \"rootfsSize\": 123,\n  \"imageUrl\": \"<string>\",\n  \"imageAuth\": \"<string>\",\n  \"imageAuthId\": \"<string>\",\n  \"ports\": \"<string>\",\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tools\": [\n    {\n      \"name\": \"<string>\",\n      \"port\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"command\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"clusterId\": \"<string>\",\n  \"networkStorages\": [\n    {\n      \"Id\": \"<string>\",\n      \"mountPoint\": \"<string>\"\n    }\n  ],\n  \"networkId\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"month\": 123,\n  \"billingMode\": \"<string>\",\n  \"autoRenew\": true,\n  \"autoRenewMonth\": 123,\n  \"minCudaVersion\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>"
}

POST

gpu-instance

openapi

gpu

instance

create

Create GPU Instance

curl --request POST \
  --url https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "name": "<string>",
  "productId": "<string>",
  "gpuNum": 123,
  "rootfsSize": 123,
  "imageUrl": "<string>",
  "imageAuth": "<string>",
  "imageAuthId": "<string>",
  "ports": "<string>",
  "envs": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "tools": [
    {
      "name": "<string>",
      "port": "<string>",
      "type": "<string>"
    }
  ],
  "command": "<string>",
  "entrypoint": "<string>",
  "clusterId": "<string>",
  "networkStorages": [
    {
      "Id": "<string>",
      "mountPoint": "<string>"
    }
  ],
  "networkId": "<string>",
  "kind": "<string>",
  "month": 123,
  "billingMode": "<string>",
  "autoRenew": true,
  "autoRenewMonth": 123,
  "minCudaVersion": "<string>"
}
'

import requests

url = "https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create"

payload = {
    "name": "<string>",
    "productId": "<string>",
    "gpuNum": 123,
    "rootfsSize": 123,
    "imageUrl": "<string>",
    "imageAuth": "<string>",
    "imageAuthId": "<string>",
    "ports": "<string>",
    "envs": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "tools": [
        {
            "name": "<string>",
            "port": "<string>",
            "type": "<string>"
        }
    ],
    "command": "<string>",
    "entrypoint": "<string>",
    "clusterId": "<string>",
    "networkStorages": [
        {
            "Id": "<string>",
            "mountPoint": "<string>"
        }
    ],
    "networkId": "<string>",
    "kind": "<string>",
    "month": 123,
    "billingMode": "<string>",
    "autoRenew": True,
    "autoRenewMonth": 123,
    "minCudaVersion": "<string>"
}
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "<authorization>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
  body: JSON.stringify({
    name: '<string>',
    productId: '<string>',
    gpuNum: 123,
    rootfsSize: 123,
    imageUrl: '<string>',
    imageAuth: '<string>',
    imageAuthId: '<string>',
    ports: '<string>',
    envs: [{key: '<string>', value: '<string>'}],
    tools: [{name: '<string>', port: '<string>', type: '<string>'}],
    command: '<string>',
    entrypoint: '<string>',
    clusterId: '<string>',
    networkStorages: [{Id: '<string>', mountPoint: '<string>'}],
    networkId: '<string>',
    kind: '<string>',
    month: 123,
    billingMode: '<string>',
    autoRenew: true,
    autoRenewMonth: 123,
    minCudaVersion: '<string>'
  })
};

fetch('https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'productId' => '<string>',
    'gpuNum' => 123,
    'rootfsSize' => 123,
    'imageUrl' => '<string>',
    'imageAuth' => '<string>',
    'imageAuthId' => '<string>',
    'ports' => '<string>',
    'envs' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'tools' => [
        [
                'name' => '<string>',
                'port' => '<string>',
                'type' => '<string>'
        ]
    ],
    'command' => '<string>',
    'entrypoint' => '<string>',
    'clusterId' => '<string>',
    'networkStorages' => [
        [
                'Id' => '<string>',
                'mountPoint' => '<string>'
        ]
    ],
    'networkId' => '<string>',
    'kind' => '<string>',
    'month' => 123,
    'billingMode' => '<string>',
    'autoRenew' => true,
    'autoRenewMonth' => 123,
    'minCudaVersion' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"gpuNum\": 123,\n  \"rootfsSize\": 123,\n  \"imageUrl\": \"<string>\",\n  \"imageAuth\": \"<string>\",\n  \"imageAuthId\": \"<string>\",\n  \"ports\": \"<string>\",\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tools\": [\n    {\n      \"name\": \"<string>\",\n      \"port\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"command\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"clusterId\": \"<string>\",\n  \"networkStorages\": [\n    {\n      \"Id\": \"<string>\",\n      \"mountPoint\": \"<string>\"\n    }\n  ],\n  \"networkId\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"month\": 123,\n  \"billingMode\": \"<string>\",\n  \"autoRenew\": true,\n  \"autoRenewMonth\": 123,\n  \"minCudaVersion\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "<authorization>")
  .body("{\n  \"name\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"gpuNum\": 123,\n  \"rootfsSize\": 123,\n  \"imageUrl\": \"<string>\",\n  \"imageAuth\": \"<string>\",\n  \"imageAuthId\": \"<string>\",\n  \"ports\": \"<string>\",\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tools\": [\n    {\n      \"name\": \"<string>\",\n      \"port\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"command\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"clusterId\": \"<string>\",\n  \"networkStorages\": [\n    {\n      \"Id\": \"<string>\",\n      \"mountPoint\": \"<string>\"\n    }\n  ],\n  \"networkId\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"month\": 123,\n  \"billingMode\": \"<string>\",\n  \"autoRenew\": true,\n  \"autoRenewMonth\": 123,\n  \"minCudaVersion\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.novita.ai/gpu-instance/openapi/v1/gpu/instance/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n  \"name\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"gpuNum\": 123,\n  \"rootfsSize\": 123,\n  \"imageUrl\": \"<string>\",\n  \"imageAuth\": \"<string>\",\n  \"imageAuthId\": \"<string>\",\n  \"ports\": \"<string>\",\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tools\": [\n    {\n      \"name\": \"<string>\",\n      \"port\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"command\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"clusterId\": \"<string>\",\n  \"networkStorages\": [\n    {\n      \"Id\": \"<string>\",\n      \"mountPoint\": \"<string>\"\n    }\n  ],\n  \"networkId\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"month\": 123,\n  \"billingMode\": \"<string>\",\n  \"autoRenew\": true,\n  \"autoRenewMonth\": 123,\n  \"minCudaVersion\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>"
}

Request Headers

string

required

Enum: application/json

string

required

Bearer authentication format, for example: Bearer {{API Key}}.

Request Body

string

Instance name. String, length limit: 0-255 characters.

string

required

GPU product ID. String, length limit: 1-255 characters. You can query this via the List GPU Products API.

integer

required

Number of GPUs. Integer, valid range: [1, 8].

integer

required

Root filesystem size. Integer, valid range: [10, 6144]. If the minimum value is less than 10 GB, the system will default to 10 GB. The maximum value is dynamically limited by available storage resources and can be queried via the product list API.

string

required

Image URL. String, length limit: 1-500 characters.

string

Image authentication (username:password). String, length limit: 0-10239 characters.

string

Image repository authentication ID.

string

Instance open ports, e.g.: 80/http, 3306/tcp. Supported port range: [1-65535], except for 2222, 2223, 2224 which are reserved for internal use. Supported port types: [tcp, http]. The total number of ports used by ports + tools must not exceed 15.

object[]

Instance environment variables. Up to 100 environment variables can be created.

Show properties

string

Environment variable name. String, length limit: 0-511 characters.

string

Environment variable value. String, length limit: 0-4095 characters.

object[]

Enable official image support tools. Currently, some official images only include Jupyter. The total number of ports used by ports + tools must not exceed 15.

Show properties

string

Tool name. Valid values: [Jupyter].

string

Port used by the tool. Supported port range: [1-65535], except for 2222, 2223, 2224 which are reserved for internal use.

string

Port type used by the tool. Supported types: [tcp, http].

string

Instance startup command. String, length limit: 0-2047 characters.

string

Instance startup entrypoint. This setting will override the Docker image’s ENTRYPOINT. String, length limit: 0-2047 characters.

string

Specify the cluster ID to create the instance in. If left empty, the instance will be created in a random cluster.

object[]

Cloud storage mount configuration. Up to 30 cloud storages can be mounted.

Show properties

string

Network storage ID.

string

Network storage mount path. Default: “/network”. String, length limit: 1-4095 characters.

string

VPC network ID. Leave empty if not using a VPC network.

string

required

Instance type. Valid values: [gpu, cpu].

integer

Number of months for subscription instance. Set to 0 to create a pay-as-you-go instance. Integer, value must be greater than or equal to 0.

string

Instance billing mode. Valid values: onDemand, monthly, spot.
Default: onDemand.
Note: If month > 0 is set, monthly billing mode will be enforced.

onDemand: Pay-as-you-go billing
monthly: Monthly subscription billing
spot: Spot instance billing

boolean

Whether to automatically renew. Boolean, default value: false.
Note: This parameter is only effective when monthly billing is enabled.

integer

Number of months to automatically renew. Integer, valid range: [1, 12].
Note: This parameter is only effective when monthly billing is enabled and auto renew is enabled.

string

Minimum CUDA version supported for instance creation. Must be specified in the format: 11.8, 12.4, etc. String, length limit: 0-255 characters.

Response

string

Created instance ID.

Last modified on January 19, 2026

List Clusters Create CPU Instance

Overview

Basic

Quota

Team Budget

API Key Model Access

Model APIs

GPUs

Create GPU Instance

Request Headers

Request Body

Response

​Request Headers

​Request Body

​Response

Request Headers

Request Body

Response