List Jobs

GET

https://host.com/apis/jobs/v2/workspaces/:workspace/jobs

GET

/apis/jobs/v2/workspaces/:workspace/jobs

$ curl https://host.com/apis/jobs/v2/workspaces/workspace/jobs \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "id": "job-9f8b7c6d-1234-4a56-b789-0a1b2c3d4e5f",
5       "attempt_id": "attempt-001",
6       "name": "data-preprocessing",
7       "workspace": "research-team-alpha",
8       "source": "gitlab-repo-ml",
9       "platform_spec": {
10         "steps": [
11           {
12             "name": "preprocess",
13             "executor": {
14               "provider": "cpu",
15               "container": {
16                 "image": "python:3.9-slim",
17                 "entrypoint": [
18                   "/bin/bash",
19                   "-c"
20                 ],
21                 "command": [
22                   "python preprocess.py --input $DATA_PATH --output /mnt/data/processed"
23                 ]
24               },
25               "profile": "default",
26               "resources": {
27                 "requests": {
28                   "cpu": "500m",
29                   "memory": "1Gi"
30                 },
31                 "limits": {
32                   "cpu": "1",
33                   "memory": "2Gi"
34                 },
35                 "num_nodes": 1,
36                 "num_gpus": 0,
37                 "shm_size": "1Gi"
38               }
39             },
40             "environment": [
41               {
42                 "name": "DATA_PATH",
43                 "value": "/mnt/data/raw",
44                 "from_secret": {
45                   "name": "aws-access-key"
46                 }
47               }
48             ],
49             "config": {},
50             "lifecycle": {
51               "staleness_timeout_seconds": 300
52             }
53           }
54         ]
55       },
56       "fileset": "fileset-1234567890abcdef",
57       "status": "created",
58       "project": "urn:project:ml-model-training",
59       "description": "Preprocessing step for ML model training dataset",
60       "spec": {},
61       "status_details": {},
62       "error_details": {},
63       "created_at": "2024-01-15T09:30:00Z",
64       "updated_at": "2024-01-15T09:30:00Z",
65       "ownership": {},
66       "custom_fields": {}
67     }
68   ],
69   "pagination": {
70     "page": 1,
71     "page_size": 10,
72     "current_page_size": 1,
73     "total_pages": 1,
74     "total_results": 1
75   },
76   "sort": "-created_at",
77   "filter": {}
78 }

List platform jobs with filtering and pagination.

Path parameters

workspacestringRequired

Query parameters

pageintegerOptionalDefaults to 1

Page number.

page_sizeintegerOptionalDefaults to 10

Page size.

sortenumOptionalDefaults to -created_at

The field to sort by. To sort in decreasing order, use - in front of the field name.

Allowed values:

filterobjectOptional

Filter jobs by workspace, project, name, status, source, created_at, and updated_at.

Response

Successful Response

datalist of objects

paginationobject

Pagination information.

sortstring

The field on which the results are sorted.

filtermap from strings to any

Filtering information.

Errors

422

Unprocessable Entity Error