Create a job
Submit a new batch job for execution
POST
Submit a new batch job for execution. Jobs run the specified command to completion and then terminate.
Path parameters
namespace
type: string
requiredThe namespace (user or organization) to run the job in.
Body parameters
name
type: string
requiredA unique name for the job within the namespace. Must be 1-64 characters. Allowed characters: alphanumeric, hyphens, underscores.
cloud
type: string
requiredCloud provider to run the job on. One of `aws`, `azure`, `gcp`.
region
type: string
requiredCloud region to deploy in (e.g., `us-east-1`, `westus2`, `europe-west1`).
zone
type: string
Availability zone within the region.
command
type: string
requiredThe command to execute. This is run as the job entrypoint.
num_nodes
type: integer
Number of nodes to provision for the job.
default: 1
cpus
type: string
CPU count. Specify an exact value like `"4"` or a minimum with `"4+"`.
memory
type: string
Memory in GB. Specify an exact value like `"16"` or a minimum with `"16+"`.
gpus
type: string
GPU configuration in `GPU_TYPE:COUNT` format. For example, `"A100:4"`, `"V100:1"`, `"H100:8"`.
disk_size_gb
type: integer
Ephemeral disk size in gigabytes.
disk_tier
type: string
Disk performance tier. One of `standard`, `high`, `ultra`.
default: standard
instance_type
type: string
Specific cloud instance type to use, overriding automatic selection from CPU/GPU/memory requirements.
spot
type: boolean
Use spot (AWS), preemptible (GCP), or low-priority (Azure) instances for reduced cost.
default: false
setup
type: string
Setup commands to run before the main job command. Use this for installing dependencies or downloading data.
workdir
type: string
Working directory for the job command.
envs
type: object
Environment variables as key-value pairs.
max_restarts
type: integer
Maximum number of automatic restarts on failure.
default: 3
Previous → Delete a machine
Next List jobs →