Get Pods

Get Pods

curl --request GET \
  --url https://api.primeintellect.ai/api/v1/pods/ \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "userId": "<string>",
      "name": "<string>",
      "providerType": "runpod",
      "gpuName": "CPU_NODE",
      "gpuCount": 123,
      "socket": "PCIe",
      "priceHr": 123,
      "id": "<string>",
      "teamId": "<string>",
      "walletId": "<string>",
      "type": "HOSTED",
      "status": "PROVISIONING",
      "installationStatus": "PENDING",
      "installationFailure": "<string>",
      "installationProgress": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "terminatedAt": "2023-11-07T05:31:56Z",
      "stoppedPriceHr": 0.005,
      "provisioningPriceHr": 0,
      "environmentType": "ubuntu_22_cuda_12",
      "customTemplateId": "<string>",
      "clusterId": "<string>",
      "primePortMapping": [],
      "sshConnection": "<string>",
      "ip": "<string>",
      "resources": {
        "memory": "128",
        "disk": "1000",
        "vcpus": "32",
        "shared_disk": "1000"
      },
      "attachedResources": [],
      "isSpot": true,
      "autoRestart": true
    }
  ],
  "total_count": 0,
  "offset": 0,
  "limit": 100
}

GET

api

pods

Get Pods

curl --request GET \
  --url https://api.primeintellect.ai/api/v1/pods/ \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "userId": "<string>",
      "name": "<string>",
      "providerType": "runpod",
      "gpuName": "CPU_NODE",
      "gpuCount": 123,
      "socket": "PCIe",
      "priceHr": 123,
      "id": "<string>",
      "teamId": "<string>",
      "walletId": "<string>",
      "type": "HOSTED",
      "status": "PROVISIONING",
      "installationStatus": "PENDING",
      "installationFailure": "<string>",
      "installationProgress": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "terminatedAt": "2023-11-07T05:31:56Z",
      "stoppedPriceHr": 0.005,
      "provisioningPriceHr": 0,
      "environmentType": "ubuntu_22_cuda_12",
      "customTemplateId": "<string>",
      "clusterId": "<string>",
      "primePortMapping": [],
      "sshConnection": "<string>",
      "ip": "<string>",
      "resources": {
        "memory": "128",
        "disk": "1000",
        "vcpus": "32",
        "shared_disk": "1000"
      },
      "attachedResources": [],
      "isSpot": true,
      "autoRestart": true
    }
  ],
  "total_count": 0,
  "offset": 0,
  "limit": 100
}

Authorizations

Authorization

string

header

required

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

Query Parameters

offset

integer

default:0

limit

integer

default:100

Response

Successful Response

data

APIPodConfig · object[]

required

Show child attributes

data.userId

string

required

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

data.name

string

required

Name of the pod.

data.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,

dc_roan,

nebius,

dc_eland,

dc_wildebeest,

vultr,

dc_gnu

data.gpuName

enum<string>

required

Model of the GPU allocated.

Available options:

CPU_NODE,

A10_24GB,

A100_80GB,

A100_40GB,

A30_24GB,

A40_48GB,

B200_180GB,

B300_262GB,

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

data.gpuCount

integer

required

Number of GPUs allocated to the node.

data.socket

enum<string>

required

Type of socket used by the GPU.

Available options:

PCIe,

SXM2,

SXM3,

SXM4,

SXM5,

SXM6

data.priceHr

number

required

Hourly price for running the pod.

data.id

string

Unique identifier for the pod, generated as a UUID.

data.teamId

string | null

ID of the team owning this pod, if applicable.

data.walletId

string | null

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

data.type

enum<string>

default:HOSTED

deprecated

Type of the pod, based on PodTypeEnum.

Available options:

HOSTED,

EXTERNAL

data.status

enum<string>

default:PROVISIONING

Current status of the pod, based on PodStatusEnum.

Available options:

PROVISIONING,

PENDING,

ACTIVE,

STOPPED,

ERROR,

DELETING,

UNKNOWN,

TERMINATED

data.installationStatus

enum<string>

default:PENDING

Installation status of the pod, based on InstallationStatusEnum.

Available options:

PENDING,

ACTIVE,

FINISHED,

ERROR,

TERMINATED

data.installationFailure

string | null

Details about any installation failures that occurred, if applicable.

data.installationProgress

integer | null

Percentage of the installation process completed.

data.createdAt

string<date-time>

Timestamp when the pod was created.

data.updatedAt

string<date-time>

Timestamp when the pod was last updated.

data.terminatedAt

string<date-time> | null

Timestamp when the pod was terminated.

data.stoppedPriceHr

number | null

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

Example:

0.005

data.provisioningPriceHr

number | null

default:0

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

data.environmentType

enum<string>

default:ubuntu_22_cuda_12

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,

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

data.customTemplateId

string | null

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

data.clusterId

string | null

ID of the cluster to which the pod belongs.

data.primePortMapping

PortMapping · object[] | null

Port mapping.

Show child attributes

data.primePortMapping.internal

string

required

data.primePortMapping.external

string

required

data.primePortMapping.protocol

enum<string>

required

Available options:

TCP,

UDP

data.primePortMapping.usedBy

enum<string> | null

Available options:

SSH,

JUPYTER_NOTEBOOK,

WEB_SERVER

data.primePortMapping.description

string | null

data.sshConnection

SSH connection/connections details.

data.ip

IP address/addresses of the instance.

data.resources

InstanceResources · object

Instance resources.

Show child attributes

data.resources.memory

integer | null

required

RAM available (in GB)

Example:

"128"

data.resources.disk

integer | null

required

Total disk space (in GB)

Example:

"1000"

data.resources.vcpus

integer | null

required

vCPUs available

Example:

"32"

data.resources.shared_disk

integer | null

Total external shared disk space (in GB)

Example:

"1000"

data.attachedResources

AttachedResources · object[] | null

Instance attached resources.

Show child attributes

data.attachedResources.resourceType

enum<string>

required

Type of resource.

Available options:

DISK

Allowed value: "DISK"

data.attachedResources.id

required

Unique identifier for the resource.

data.attachedResources.status

enum<string>

default:UNATTACHED

Resource status.

Available options:

UNATTACHED,

ATTACHED,

MOUNTED

data.attachedResources.isDetachable

boolean

default:true

Whether the resource is detachable.

data.attachedResources.mountPath

string

default:/workspace

Path to the mount point.

data.attachedResources.resourcePath

string | null

Path to the resource.

data.attachedResources.size

Size of the resource.

data.attachedResources.isShared

boolean | null

default:false

Whether the resource is shared.

data.isSpot

boolean | null

Whether the instance is spot.

data.autoRestart

boolean | null

Automatically restart the instance.

total_count

integer

default:0

Total number of items available in the dataset

offset

integer

default:0

Number of items to skip before starting to collect the result set

Required range: x >= 0

limit

integer

default:100

Maximum number of items to return

Required range: x >= 0

Push Samples Create Pod

⌘I

API Documentation

Compute API

Inference API

Availability

Disks

evals

Pods

Sandbox

SSH Keys

user

Authorizations

Query Parameters

Response