Skip to main content
POST
/
gpus
/
v2
/
prewarm-tasks
Create Image Prewarm Task
curl --request POST \
  --url https://api.novita.ai/gpus/v2/prewarm-tasks \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "image": "registry.example.com/team/image:tag",
  "region_id": "region-a",
  "registry_auth_id": "registry-auth-id",
  "product_ids": [
    "product-a",
    "product-b"
  ],
  "note": ""
}
'
import requests

url = "https://api.novita.ai/gpus/v2/prewarm-tasks"

payload = {
"image": "registry.example.com/team/image:tag",
"region_id": "region-a",
"registry_auth_id": "registry-auth-id",
"product_ids": ["product-a", "product-b"],
"note": ""
}
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({
image: 'registry.example.com/team/image:tag',
region_id: 'region-a',
registry_auth_id: 'registry-auth-id',
product_ids: ['product-a', 'product-b'],
note: ''
})
};

fetch('https://api.novita.ai/gpus/v2/prewarm-tasks', 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/gpus/v2/prewarm-tasks",
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([
'image' => 'registry.example.com/team/image:tag',
'region_id' => 'region-a',
'registry_auth_id' => 'registry-auth-id',
'product_ids' => [
'product-a',
'product-b'
],
'note' => ''
]),
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/gpus/v2/prewarm-tasks"

payload := strings.NewReader("{\n \"image\": \"registry.example.com/team/image:tag\",\n \"region_id\": \"region-a\",\n \"registry_auth_id\": \"registry-auth-id\",\n \"product_ids\": [\n \"product-a\",\n \"product-b\"\n ],\n \"note\": \"\"\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/gpus/v2/prewarm-tasks")
.header("Content-Type", "<content-type>")
.header("Authorization", "<authorization>")
.body("{\n \"image\": \"registry.example.com/team/image:tag\",\n \"region_id\": \"region-a\",\n \"registry_auth_id\": \"registry-auth-id\",\n \"product_ids\": [\n \"product-a\",\n \"product-b\"\n ],\n \"note\": \"\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.novita.ai/gpus/v2/prewarm-tasks")

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 \"image\": \"registry.example.com/team/image:tag\",\n \"region_id\": \"region-a\",\n \"registry_auth_id\": \"registry-auth-id\",\n \"product_ids\": [\n \"product-a\",\n \"product-b\"\n ],\n \"note\": \"\"\n}"

response = http.request(request)
puts response.read_body
{
  "task_id": "prewarm-task-id"
}

Headers

Content-Type
string
required

Allowed value: application/json.

Authorization
string
required

Bearer authentication format, e.g.: Bearer {{API_KEY}}.

Body

application/json
image
string
required

Fully qualified image to prewarm. String, length: 1-4095 characters.

Example:

"registry.example.com/team/image:tag"

region_id
string
required

Target region ID. String, length: 1-255 characters.

Example:

"region-a"

registry_auth_id
string

Registry authentication ID. Required when prewarming a private image. String, length: 0-255 characters.

Example:

"registry-auth-id"

product_ids
string[]

Product IDs to cover with prewarming.

Example:
["product-a", "product-b"]
note
string

Note for the prewarm task.

Example:

""

Response

200 - application/json

OK

task_id
string

Image prewarm task ID

Example:

"prewarm-task-id"

Last modified on June 23, 2026