Skip to main content
POST
/
gpu-instance
/
openapi
/
v1
/
image
/
prewarm
Create Image Prewarm Task
curl --request POST \
  --url https://api.novita.ai/gpu-instance/openapi/v1/image/prewarm \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "imageUrl": "<string>",
  "repositoryAuth": "<string>",
  "clusterId": "<string>",
  "productIds": [
    "<string>"
  ],
  "note": "<string>"
}
'
{
  "id": "<string>"
}

​
Request Headers

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

​
Request Body

​
imageUrl
string
required
Image address to prewarm.
​
repositoryAuth
string
Image registry authentication ID. Required only for private registries.
​
clusterId
string
required
Cluster ID where the image should be prewarmed.
​
productIds
string[]
Product IDs to prewarm on. Leave empty to prewarm globally in the cluster.
​
note
string
Task note or description.

​
Response

​
id
string
required
Created prewarm task ID.
Last modified on September 15, 2025