Sign in

v2

latestOpenAPI 3.1.02026-07-2675166192.8 KB
Pods

Create Pod

post/api/v1/pods/

Request body

disksstring[] nullable
team_member_idsstring[] nullable
shared_with_teamboolean

Response

Successful Response

idstring

Unique identifier for the pod, generated as a UUID.

userIdstring required

ID of the user associated with this pod, if applicable.

teamIdstring nullable

ID of the team owning this pod, if applicable.

walletIdstring nullable

ID of the wallet associated with this pod for billing or resource tracking.

namestring required

Name of the pod.

type'HOSTED' | 'EXTERNAL'
providerType'runpod' | 'fluidstack' | 'lambdalabs' | 'hyperstack' | 'oblivus' | 'cudocompute' | 'scaleway' | 'tensordock' | 'datacrunch' | 'latitude' | 'crusoecloud' | 'massedcompute' | 'akash' | 'primeintellect' | 'primecompute' | 'dc_impala' | 'dc_kudu' | 'dc_roan' | 'nebius' | 'dc_eland' | 'dc_wildebeest' | 'vultr' | 'dc_gnu' | 'denvr' required
status'PROVISIONING' | 'PENDING' | 'ACTIVE' | 'STOPPED' | 'ERROR' | 'DELETING' | 'UNKNOWN' | 'TERMINATED'
installationStatus'PENDING' | 'ACTIVE' | 'FINISHED' | 'ERROR' | 'TERMINATED'
installationFailurestring nullable

Details about any installation failures that occurred, if applicable.

installationProgressinteger nullable

Percentage of the installation process completed.

createdAtstring date-time

Timestamp when the pod was created.

updatedAtstring date-time

Timestamp when the pod was last updated.

terminatedAtstring date-time nullable

Timestamp when the pod was terminated.

gpuName'CPU_NODE' | 'A10_24GB' | 'A100_80GB' | 'A100_40GB' | 'A30_24GB' | 'A40_48GB' | 'B200_180GB' | 'B300_262GB' | 'GB200' | 'GB300' | 'RTX3070_8GB' | 'RTX3070_8GB' | 'RTX3080_10GB' | 'RTX3080Ti_12GB' | 'RTX3090_24GB' | 'RTX3090Ti_24GB' | 'RTX4070Ti_12GB' | 'RTX4080_16GB' | 'RTX4080Ti_16GB' | 'RTX4090_24GB' | 'RTX5090_32GB' | 'H100_80GB' | 'H200_96GB' | 'GH200_96GB' | 'H200_141GB' | 'GH200_480GB' | 'GH200_624GB' | 'L4_24GB' | 'L40_48GB' | 'L40S_48GB' | 'RTX4000_8GB' | 'RTX5000_16GB' | 'RTX6000_24GB' | 'RTX8000_48GB' | 'RTX2000Ada_16GB' | 'RTX4000Ada_20GB' | 'RTX5000Ada_32GB' | 'RTX6000Ada_48GB' | 'A2000_6GB' | 'A4000_16GB' | 'A4500_20GB' | 'A5000_24GB' | 'A6000_48GB' | 'V100_16GB' | 'V100_32GB' | 'P100_16GB' | 'T4_16GB' | 'P4_8GB' | 'P40_24GB' | 'RTX_PRO_6000B_96GB' required
gpuCountinteger required

Number of GPUs allocated to the node.

socket'PCIe' | 'SXM2' | 'SXM3' | 'SXM4' | 'SXM5' | 'SXM6' required
priceHrnumber required

Hourly price for running the pod.

stoppedPriceHrnumber nullable

Hourly price when the pod is stopped. If empty then priceHr is used.

provisioningPriceHrnumber nullable

Hourly price during the provisioning process. If empty then priceHr is used.

environmentType'ubuntu_22_cuda_12' | 'ubuntu_26' | 'cuda_12_1_pytorch_2_2' | 'cuda_11_8_pytorch_2_1' | 'cuda_12_1_pytorch_2_3' | 'cuda_12_1_pytorch_2_4' | 'cuda_12_4_pytorch_2_4' | 'cuda_12_4_pytorch_2_5' | 'cuda_12_4_pytorch_2_6' | 'cuda_12_6_pytorch_2_7' | 'stable_diffusion' | 'axolotl' | 'bittensor' | 'hivemind' | 'petals_llama' | 'vllm_llama_8b' | 'vllm_llama_70b' | 'vllm_llama_405b' | 'custom_template' | 'flux' | 'prime_rl'
customTemplateIdstring nullable

ID of the custom template applied to the pod, if applicable.

clusterIdstring nullable

ID of the cluster to which the pod belongs.

isSpotboolean nullable

Whether the instance is spot.

autoRestartboolean nullable

Automatically restart the instance.

Example response

{
  "gpuCount": 1,
  "priceHr": 1.23,
  "stoppedPriceHr": 0.005,
  "primePortMapping": [
    {
      "internal": "8080",
      "external": "1234"
    }
  ]
}