Create Job

POST

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

POST

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

$ curl -X POST https://host.com/apis/jobs/v2/workspaces/workspace/jobs \
>      -H "Content-Type: application/json" \
>      -d '{
>   "spec": {},
>   "platform_spec": {
>     "steps": [
>       {
>         "name": "preprocess",
>         "executor": {
>           "container": {
>             "image": "python:3.9-slim"
>           }
>         }
>       }
>     ]
>   },
>   "source": "git@github.com:example/repo.git"
> }'

1 {
2   "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3   "attempt_id": "attempt-20240615-001",
4   "name": "data-preprocessing-job",
5   "workspace": "research-team-alpha",
6   "source": "git@github.com:example/repo.git",
7   "platform_spec": {
8     "steps": [
9       {
10         "name": "preprocess",
11         "executor": {
12           "provider": "cpu",
13           "container": {
14             "image": "python:3.9-slim",
15             "entrypoint": [
16               "python"
17             ],
18             "command": [
19               "scripts/preprocess.py"
20             ]
21           },
22           "profile": "default",
23           "resources": {
24             "requests": {
25               "cpu": "500m",
26               "memory": "1Gi"
27             },
28             "limits": {
29               "cpu": "1",
30               "memory": "2Gi"
31             },
32             "num_nodes": 1,
33             "num_gpus": 0,
34             "shm_size": "1Gi"
35           }
36         },
37         "environment": [
38           {
39             "name": "DATA_PATH",
40             "value": "/mnt/data/raw",
41             "from_secret": {
42               "name": "db_password"
43             }
44           }
45         ],
46         "config": {},
47         "lifecycle": {
48           "staleness_timeout_seconds": 300
49         }
50       }
51     ]
52   },
53   "fileset": "fileset-1234567890abcdef",
54   "status": "created",
55   "project": "project-ml-pipeline",
56   "description": "Job to preprocess raw data for ML pipeline",
57   "spec": {},
58   "status_details": {},
59   "error_details": {},
60   "created_at": "2024-01-15T09:30:00Z",
61   "updated_at": "2024-01-15T09:30:00Z",
62   "ownership": {},
63   "custom_fields": {}
64 }

Create a new platform job.

Path parameters

workspacestringRequired

Request

This endpoint expects an object.

specmap from strings to anyRequired

platform_specobjectRequired

Specification for a platform job, containing steps and secrets.

sourcestringRequired

namestringOptional

descriptionstringOptional

projectstringOptional

ownershipmap from strings to anyOptional

custom_fieldsmap from strings to anyOptional

Response

Successful Response

idstring

attempt_idstring

namestring

workspacestring

Workspace identifier

sourcestring

platform_specobject

Specification for a platform job, containing steps and secrets.

filesetstring

Fileset ID for storing job artifacts

statusenum

Enumeration of possible job statuses. This enum represents the various states a job can be in during its lifecycle, from creation to a terminal state.

projectstring

Project URN

descriptionstring

specmap from strings to any

Job Spec

status_detailsmap from strings to any

Details about the job status

error_detailsmap from strings to any

created_atdatetime

updated_atdatetime

ownershipmap from strings to any

custom_fieldsmap from strings to any

Custom Fields

Errors

422

Unprocessable Entity Error