Skip to main content
GET
/
gpu-instance
/
openapi
/
v1
/
jobs
List Jobs
curl --request GET \
  --url https://api.novita.ai/gpu-instance/openapi/v1/jobs \
  --header 'Authorization: <authorization>'
import requests

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

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.novita.ai/gpu-instance/openapi/v1/jobs', 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/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);

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

curl_close($curl);

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

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

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

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.get("https://api.novita.ai/gpu-instance/openapi/v1/jobs")
.header("Authorization", "<authorization>")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body
{
  "jobs": [
    {
      "Id": "<string>",
      "user": "<string>",
      "type": "<string>",
      "envs": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "state": {
        "state": "<string>",
        "error": "<string>",
        "errorMessage": "<string>"
      },
      "logAddress": "<string>",
      "createdAt": "<string>",
      "instanceId": "<string>"
    }
  ]
}

API Description

Retrieve a paginated list of background jobs for GPU instances. You can filter by job ID, state, type, time range, and creators.

Request Headers

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

Query Parameters

pageSize
integer
Maximum number of items returned per page. Integer, value >= 0.
pageNum
integer
Page number to retrieve. Integer, value >= 0.
jobId
string
Filter by job ID. String, length 0–255.
state
string
Filter by job state. One of: pulling (preparing), running, fail, success, break.
type
string
Filter by job type. One of: saveImage, instanceMigrate, autoInstanceMigrate.
startTime
integer
Start of time range (Unix timestamp in seconds). Integer, value >= 0. Default: 0.
endTime
integer
End of time range (Unix timestamp in seconds). Integer, value >= 0. Default: 0.
creators
string
Filter by creator user ID.

cURL Example

curl --location --request GET 'https://api.novita.ai/gpu-instance/openapi/v1/jobs?pageSize=5&pageNum=1&jobId=&type=&state=&startTime=&endTime=&creators=' \
--header 'Authorization: Bearer {{API_KEY}}'

Response

jobs
object[]
required
Job list.
Last modified on October 15, 2025