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": {}
>         }
>       }
>     ]
>   },
>   "source": "git@github.com:nemo-platform/sample-project.git"
> }'

1 {
2   "id": "a3f47c9e-8b2d-4f3a-9c1e-2d5b7f9e4c3a",
3   "attempt_id": "attempt-20240615-001",
4   "name": "data-preprocessing-job",
5   "workspace": "nemo-workspace",
6   "source": "git@github.com:nemo-platform/sample-project.git",
7   "platform_spec": {
8     "steps": [
9       {
10         "name": "preprocess",
11         "executor": {
12           "provider": "cpu",
13           "container": {
14             "image": "nemo/data-preprocess:latest",
15             "entrypoint": [
16               "/bin/sh",
17               "-c"
18             ],
19             "command": [
20               "python preprocess.py --input /mnt/data/raw --output /mnt/data/processed"
21             ]
22           },
23           "profile": "default",
24           "resources": {
25             "requests": {
26               "cpu": "500m",
27               "memory": "1Gi"
28             },
29             "limits": {
30               "cpu": "1",
31               "memory": "2Gi"
32             },
33             "num_nodes": 1,
34             "num_gpus": 0,
35             "shm_size": "1Gi"
36           }
37         },
38         "environment": [
39           {
40             "name": "DATA_PATH",
41             "value": "/mnt/data/raw",
42             "from_secret": {
43               "name": "db_password"
44             }
45           }
46         ],
47         "config": {},
48         "lifecycle": {
49           "staleness_timeout_seconds": 300
50         }
51       }
52     ]
53   },
54   "fileset": "fileset-123456",
55   "status": "created",
56   "project": "urn:nemo:project:ml-pipeline",
57   "description": "Job to preprocess raw data for ML pipeline",
58   "spec": {},
59   "output_location": "s3://nemo-artifacts/jobs/data-preprocessing-job/",
60   "status_details": {},
61   "error_details": {},
62   "created_at": "2024-01-15T09:30:00Z",
63   "updated_at": "2024-01-15T09:30:00Z",
64   "ownership": {},
65   "custom_fields": {}
66 }

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

output_locationstringOptional

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.

projectstringOptional

Project URN

descriptionstringOptional

specmap from strings to anyOptional

Job Spec

output_locationstringOptional

Caller-supplied artifact fileset; None when the fileset was auto-created

status_detailsmap from strings to anyOptional

Details about the job status

error_detailsmap from strings to anyOptional

created_atdatetimeOptional

updated_atdatetimeOptional

ownershipmap from strings to anyOptional

custom_fieldsmap from strings to anyOptional

Custom Fields

Errors

422

Unprocessable Entity Error