Create Job

POST

http://localhost:8080/apis/jobs/v2/workspaces/:workspace/jobs

POST

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

curl -X POST http://localhost:8080/apis/jobs/v2/workspaces/workspace/jobs \
     -H "Content-Type: application/json" \
     -d '{
  "spec": {
    "message": "Hello from NeMo Helix"
  },
  "platform_spec": {
    "steps": [
      {
        "name": "run",
        "executor": {
          "provider": "cpu",
          "container": {
            "image": "python:3.11",
            "command": [
              "python",
              "-c",
              "print('\''Hello from NeMo Helix'\'')"
            ]
          }
        },
        "config": {
          "message": "Hello from NeMo Helix"
        }
      }
    ]
  },
  "source": "api-reference",
  "name": "hello-world"
}'

{
  "id": "string",
  "attempt_id": "string",
  "name": "string",
  "workspace": "string",
  "source": "string",
  "platform_spec": {
    "steps": [
      {
        "name": "preprocess",
        "executor": {
          "provider": "cpu",
          "container": {
            "image": "string",
            "entrypoint": [
              "string"
            ],
            "command": [
              "string"
            ]
          },
          "profile": "default",
          "resources": {
            "requests": {
              "cpu": "string",
              "memory": "string"
            },
            "limits": {
              "cpu": "string",
              "memory": "string"
            },
            "num_nodes": 1,
            "num_gpus": 1,
            "shm_size": "string"
          }
        },
        "environment": [
          {
            "name": "string",
            "value": "string",
            "from_secret": {
              "name": "string"
            }
          }
        ],
        "config": {},
        "gateway_providers": {},
        "gateway_read_filesets": [
          "string"
        ],
        "lifecycle": {
          "staleness_timeout_seconds": 0,
          "pause_deadline_seconds": 0,
          "ttl_seconds_active": 0
        },
        "network": {
          "ingress": [
            {
              "job_id_label": "string",
              "tcp_ports": [
                1
              ]
            }
          ]
        }
      }
    ],
    "secrets": [
      {
        "name": "string",
        "value": "string",
        "ref_id": "string"
      }
    ]
  },
  "fileset": "string",
  "status": "created",
  "project": "string",
  "description": "string",
  "spec": {},
  "control": {
    "pause_ttl_seconds": 1
  },
  "output_location": "string",
  "status_details": {},
  "error_details": {},
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "ownership": {},
  "custom_fields": {}
}

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

namestringOptionalformat: "^[a-z](?!.*--)[a-z0-9\-@.+_]{1,62}(?<!-)$"<=63 characters

Job name. Name must start with a lowercase letter, be 2-63 characters, and use lowercase letters, digits, hyphens, and dots (no consecutive hyphens, cannot end with a hyphen). Auto-generated when omitted.

descriptionstringOptional

projectstringOptional

controlobjectOptional

Mutable job behavior, including how long storage is kept after a pause. When omitted, the platform paused-storage TTL applies.

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.

CREATED means the controller has not yet considered the job. QUEUED means the controller has seen the job but not admitted it (waiting for capacity). PENDING means the backend resource exists and is waiting to start.

projectstringOptional

Project URN

descriptionstringOptional

specmap from strings to anyOptional

Job Spec

controlobjectOptional

Mutable job behavior. This is not part of the execution 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