v20

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-037924117.4 KB

Instances

Submit Instance

Submit a job to the queue or directly assign to a host.

If host_id is provided (marketplace launch), the job is assigned directly to that host and container start is attempted immediately — unless the transactional scheduler owns the job (canary/active partition), in which case the pin is recorded and placement/start stay with the claim→reserve path. Otherwise the job is queued and process_queue runs to find a host.

post/instance

Request body

namestring required

vram_needed_gbnumber

priorityinteger

tierstring nullable

num_gpusinteger

host_idstring nullable

gpu_modelstring nullable

nfs_serverstring nullable

nfs_pathstring nullable

nfs_mount_pointstring nullable

imagestring nullable

interactiveboolean

commandstring nullable

ssh_portinteger

pricing_mode'on_demand' | 'spot'

volume_idsstring[] nullable

encrypted_workspaceboolean

init_scriptstring nullable

git_repostring nullable

auto_launchstring[] nullable

exposed_portsinteger[] nullable

template_image_idstring nullable

Response

Successful Response

{"stackTrail":"paths:/instance:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}