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>'
{
  "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.
⌘I