latestOpenAPI 3.0.12026-08-10114644.5 KB

998cc08df103

API v2
Pods v2

Create Pod

Create a new pod

post/v2/pods

Request body

regionsstring[]

Acceptable region codes

namestring required

Pod name

imagestring required

Docker image name

containerRegistryAuthIdinteger

Container registry auth ID

imageRegistrystring

Image registry URL

imagePublicType'PUBLIC' | 'PRIVATE'

Image type: PUBLIC or PRIVATE

resourceType'GPU' | 'CPU'

Resource type: GPU or CPU

gpuTypestring required

GPU type

gpuCountinteger required

GPU count (must be power of 2)

isSpotboolean

Create on Spot resource when true

maxPricenumber

Spot instance max hourly price cap for the whole machine; only valid when isSpot=true

shmInGbinteger

Shared memory size in GB

minSingleCardRamInGbinteger

Minimum single card RAM in GB

minSingleCardVramInGbinteger

Minimum single card VRAM in GB

minSingleCardVcpuinteger

Minimum single card vCPU count

containerVolumeInGbinteger

Container volume size in GB

initializationCommandstring

Initialization command

callbackUrlstring

Pod lifecycle webhook callback URL. When creating a Pod, you can provide a callbackUrl in the request body. The platform will send HTTP POST notifications to this URL whenever the Pod transitions into a key lifecycle state (RUNNING, TERMINATED, FAILED, or DEGRADED).

Response

OK