POST
/
api
/
v1
/
pods
/

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
pod
object
required
provider
object
required
team
object | null

Response

200 - application/json
userId
string
required

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

name
string
required

Name of the pod.

type
enum<string>
required

Type of the pod, based on PodTypeEnum.

Available options:
HOSTED,
EXTERNAL
providerType
enum<string>
required

Type of provider associated with the pod, based on ProviderTypeEnum.

Available options:
runpod,
fluidstack,
lambdalabs,
hyperstack,
oblivus,
cudocompute,
scaleway,
tensordock,
datacrunch,
latitude,
crusoecloud,
massedcompute,
akash,
primeintellect,
primecompute,
dc_impala,
dc_kudu
gpuName
enum<string>
required

Model of the GPU allocated.

Available options:
CPU_NODE,
A10_24GB,
A100_80GB,
A100_40GB,
A30_24GB,
A40_48GB,
RTX3070_8GB,
RTX3070_8GB,
RTX3080_10GB,
RTX3080Ti_12GB,
RTX3090_24GB,
RTX3090Ti_24GB,
RTX4070Ti_12GB,
RTX4080_16GB,
RTX4080Ti_16GB,
RTX4090_24GB,
H100_80GB,
GH200_144GB,
L4_24GB,
L40_48GB,
L40S_48GB,
RTX4000_8GB,
RTX5000_16GB,
RTX6000_24GB,
RTX8000_48GB,
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
gpuCount
integer
required

Number of GPUs allocated to the node.

socket
enum<string>
required

Type of socket used by the GPU.

Available options:
PCIe,
SXM2,
SXM3,
SXM4,
SXM5
priceHr
number
required

Hourly price for running the pod.

id
string

Unique identifier for the pod, generated as a UUID.

teamId
string | null

ID of the team owning this pod, if applicable.

walletId
string | null

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

status
enum<string>

Current status of the pod, based on PodStatusEnum.

Available options:
PROVISIONING,
PENDING,
ACTIVE,
STOPPED,
ERROR,
TERMINATED
installationStatus
enum<string>

Installation status of the pod, based on InstallationStatusEnum.

Available options:
PENDING,
ACTIVE,
FINISHED,
ERROR,
TERMINATED
installationFailure
string | null

Details about any installation failures that occurred, if applicable.

installationProgress
integer | null

Percentage of the installation process completed.

createdAt
string

Timestamp when the pod was created.

updatedAt
string

Timestamp when the pod was last updated.

jupyterPassword
string | null

Password for accessing the Jupyter environment on the pod, if applicable.

stoppedPriceHr
number | null

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

provisioningPriceHr
number | null

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

basePriceHr
number | null

Base hourly price for the pod. If the base currency is set.

baseCurrency
string | null

Currency in which the base price is calculated.

environmentType
enum<string>

Type of image selected for the pod.

Available options:
ubuntu_22_cuda_12,
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,
stable_diffusion,
axolotl,
bittensor,
hivemind,
petals_llama,
vllm_llama_8b,
vllm_llama_70b,
vllm_llama_405b,
custom_template,
flux
customTemplateId
string | null

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

primePortMapping
object[] | null

Port mapping.

sshConnection

SSH connection/connections details.

ip

IP address/addresses of the instance.

resources
object | null

Instance resources.

attachedResources
object[] | null

Instance attached resources.

isSpot
boolean | null

Whether the instance is spot.

autoRestart
boolean | null

Automatically restart the instance.

Get PodsGet Pods History