Skip to main content
GET
/
api
/
jobs
List Jobs
curl --request GET \
  --url https://api.example.com/api/jobs \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "created_by": {},
      "resource": {}
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Key
string | null

Query Parameters

​
status
enum<string> | null

Filter by status

Available options:
initializing,
pending,
queued,
running,
succeeded,
failed,
canceled,
rejected
​
type
enum<string> | null

Filter by type

Available options:
dataset_ingest,
train,
infer_sync,
infer_batch,
evaluate,
export
​
limit
integer
default:50
Required range: 1 <= x <= 200
​
cursor
string | null

Pagination cursor

Response

Successful Response

Response for listing jobs.

​
items
Job · object[]
required
​
next_cursor
string | null