RunPod GraphQL API Spec

RunPod API spec includes most common GraphQL types, queries, and mutations to manage your pods. If you need additional support, contact us.

API Endpoints
https://api.runpod.io/graphql?api_key=pewpew
Version

1.0.0

Queries

cpuTypes

Response

Returns [CpuType]

Example

Query
query cpuTypes {
  cpuTypes {
    id
    displayName
    manufacturer
    cores
    threadsPerCore
  }
}
Response
{
  "data": {
    "cpuTypes": [
      {
        "id": "abc123",
        "displayName": "xyz789",
        "manufacturer": "xyz789",
        "cores": 987,
        "threadsPerCore": 123
      }
    ]
  }
}
Queries

gpuTypes

Response

Returns [GpuType]

Arguments
Name Description
input - GpuTypeFilter

Example

Query
query gpuTypes($input: GpuTypeFilter) {
  gpuTypes(input: $input) {
    lowestPrice {
      ...LowestPriceFragment
    }
    maxGpuCount
    id
    displayName
    manufacturer
    memoryInGb
    cudaCores
    secureCloud
    communityCloud
    securePrice
    communityPrice
  }
}
Variables
{"input": GpuTypeFilter}
Response
{
  "data": {
    "gpuTypes": [
      {
        "lowestPrice": LowestPrice,
        "maxGpuCount": 987,
        "id": "xyz789",
        "displayName": "abc123",
        "manufacturer": "abc123",
        "memoryInGb": 987,
        "cudaCores": 123,
        "secureCloud": false,
        "communityCloud": false,
        "securePrice": 123.45,
        "communityPrice": 987.65
      }
    ]
  }
}
Queries

myself

Response

Returns a User

Example

Query
query myself {
  myself {
    pods {
      ...PodFragment
    }
    machines {
      ...MachineFragment
    }
    id
    containerRegistryCreds {
      ...ContainerRegistryAuthFragment
    }
    currentSpendPerHr
    machineQuota
    referralEarned
    signedTermsOfService
    spendLimit
    stripeSavedPaymentId
    stripeSavedPaymentLast4
    templateEarned
    multiFactorEnabled
    machineEarnings {
      ...MachineEarningFragment
    }
    clientBalance
    hostBalance
    hostStripeLinked
    stripeAccountId
    stripeReloadHistory {
      ...StripeReloadTransactionFragment
    }
    dailyCharges {
      ...ClientCreditChargeFragment
    }
    referral {
      ...UserReferralFragment
    }
    apiKeys {
      ...ApiKeyFragment
    }
    pubKey
    information {
      ...UserInformationFragment
    }
    podTemplates {
      ...PodTemplateFragment
    }
    creditCodes {
      ...CreditCodeFragment
    }
  }
}
Response
{
  "data": {
    "myself": {
      "pods": [Pod],
      "machines": [Machine],
      "id": "abc123",
      "containerRegistryCreds": [ContainerRegistryAuth],
      "currentSpendPerHr": 123.45,
      "machineQuota": 987,
      "referralEarned": 987.65,
      "signedTermsOfService": true,
      "spendLimit": 987,
      "stripeSavedPaymentId": "abc123",
      "stripeSavedPaymentLast4": "abc123",
      "templateEarned": 123.45,
      "multiFactorEnabled": false,
      "machineEarnings": [MachineEarning],
      "clientBalance": 123.45,
      "hostBalance": 123.45,
      "hostStripeLinked": false,
      "stripeAccountId": "xyz789",
      "stripeReloadHistory": [StripeReloadTransaction],
      "dailyCharges": [ClientCreditCharge],
      "referral": UserReferral,
      "apiKeys": [ApiKey],
      "pubKey": "abc123",
      "information": UserInformation,
      "podTemplates": [PodTemplate],
      "creditCodes": [CreditCode]
    }
  }
}
Queries

pod

Response

Returns a Pod

Arguments
Name Description
input - PodFilter

Example

Query
query pod($input: PodFilter) {
  pod(input: $input) {
    lowestBidPriceToResume
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
  }
}
Variables
{"input": PodFilter}
Response
{
  "data": {
    "pod": {
      "lowestBidPriceToResume": 987.65,
      "apiKey": "xyz789",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 987.65,
      "costPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "xyz789",
      "env": ["abc123"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "abc123",
      "lastStatusChange": "abc123",
      "locked": true,
      "machineId": "xyz789",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 7100,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 987,
      "vcpuCount": 987.65,
      "version": 987,
      "volumeEncrypted": false,
      "volumeInGb": 987.65,
      "volumeKey": "xyz789",
      "volumeMountPath": "abc123",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry
    }
  }
}

Mutations

podBidResume

Response

Returns a Pod

Arguments
Name Description
input - PodBidResumeInput!

Example

Query
mutation podBidResume($input: PodBidResumeInput!) {
  podBidResume(input: $input) {
    lowestBidPriceToResume
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
  }
}
Variables
{"input": PodBidResumeInput}
Response
{
  "data": {
    "podBidResume": {
      "lowestBidPriceToResume": 123.45,
      "apiKey": "abc123",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 987.65,
      "costPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "xyz789",
      "env": ["xyz789"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "xyz789",
      "lastStatusChange": "xyz789",
      "locked": true,
      "machineId": "abc123",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 7100,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 987,
      "vcpuCount": 123.45,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "xyz789",
      "volumeMountPath": "xyz789",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry
    }
  }
}
Mutations

podFindAndDeployOnDemand

Response

Returns a Pod

Arguments
Name Description
input - PodFindAndDeployOnDemandInput

Example

Query
mutation podFindAndDeployOnDemand($input: PodFindAndDeployOnDemandInput) {
  podFindAndDeployOnDemand(input: $input) {
    lowestBidPriceToResume
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
  }
}
Variables
{"input": PodFindAndDeployOnDemandInput}
Response
{
  "data": {
    "podFindAndDeployOnDemand": {
      "lowestBidPriceToResume": 123.45,
      "apiKey": "xyz789",
      "consumerUserId": "abc123",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 987.65,
      "costPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "abc123",
      "env": ["xyz789"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "xyz789",
      "lastStatusChange": "xyz789",
      "locked": false,
      "machineId": "abc123",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 7100,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 123,
      "vcpuCount": 987.65,
      "version": 987,
      "volumeEncrypted": true,
      "volumeInGb": 987.65,
      "volumeKey": "abc123",
      "volumeMountPath": "xyz789",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry
    }
  }
}
Mutations

podRentInterruptable

Response

Returns a Pod

Arguments
Name Description
input - PodRentInterruptableInput!

Example

Query
mutation podRentInterruptable($input: PodRentInterruptableInput!) {
  podRentInterruptable(input: $input) {
    lowestBidPriceToResume
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
  }
}
Variables
{"input": PodRentInterruptableInput}
Response
{
  "data": {
    "podRentInterruptable": {
      "lowestBidPriceToResume": 123.45,
      "apiKey": "abc123",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "abc123",
      "costMultiplier": 123.45,
      "costPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "xyz789",
      "env": ["xyz789"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "xyz789",
      "lastStatusChange": "abc123",
      "locked": false,
      "machineId": "xyz789",
      "memoryInGb": 987.65,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 7100,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 123.45,
      "version": 987,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "xyz789",
      "volumeMountPath": "xyz789",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry
    }
  }
}
Mutations

podResume

Response

Returns a Pod

Arguments
Name Description
input - PodResumeInput!

Example

Query
mutation podResume($input: PodResumeInput!) {
  podResume(input: $input) {
    lowestBidPriceToResume
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
  }
}
Variables
{"input": PodResumeInput}
Response
{
  "data": {
    "podResume": {
      "lowestBidPriceToResume": 987.65,
      "apiKey": "xyz789",
      "consumerUserId": "abc123",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 987.65,
      "costPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "abc123",
      "env": ["abc123"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "xyz789",
      "lastStatusChange": "abc123",
      "locked": false,
      "machineId": "xyz789",
      "memoryInGb": 123.45,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 7100,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 123.45,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "xyz789",
      "volumeMountPath": "abc123",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry
    }
  }
}
Mutations

podStop

Response

Returns a Pod

Arguments
Name Description
input - PodStopInput!

Example

Query
mutation podStop($input: PodStopInput!) {
  podStop(input: $input) {
    lowestBidPriceToResume
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
  }
}
Variables
{"input": PodStopInput}
Response
{
  "data": {
    "podStop": {
      "lowestBidPriceToResume": 987.65,
      "apiKey": "abc123",
      "consumerUserId": "abc123",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "abc123",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["abc123"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "abc123",
      "lastStatusChange": "abc123",
      "locked": true,
      "machineId": "xyz789",
      "memoryInGb": 987.65,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 7100,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 123.45,
      "version": 987,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "abc123",
      "volumeMountPath": "xyz789",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry
    }
  }
}
Mutations

podTerminate

Response

Returns a Void

Arguments
Name Description
input - PodTerminateInput!

Example

Query
mutation podTerminate($input: PodTerminateInput!) {
  podTerminate(input: $input)
}
Variables
{"input": PodTerminateInput}
Response
{"data": {"podTerminate": null}}

Types

ApiKey

Fields
Field Name Description
id - String
permissions - String!
createdAt - DateTime!
Example
{
  "id": "abc123",
  "permissions": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

ClientCreditCharge

Fields
Field Name Description
amount - Float
updatedAt - Date
Example
{
  "amount": 987.65,
  "updatedAt": "2007-12-03"
}
Types

CloudTypeEnum

Values
Enum Value Description

SECURE

COMMUNITY

ALL
Example
"SECURE"
Types

ContainerRegistryAuth

Fields
Field Name Description
id - String
name - String
userId - String
registryAuth - String
Example
{
  "id": "abc123",
  "name": "abc123",
  "userId": "xyz789",
  "registryAuth": "xyz789"
}
Types

CpuType

Fields
Field Name Description
id - String
displayName - String
manufacturer - String
cores - Int
threadsPerCore - Int
Example
{
  "id": "abc123",
  "displayName": "abc123",
  "manufacturer": "xyz789",
  "cores": 987,
  "threadsPerCore": 987
}
Types

CreditCode

Fields
Field Name Description
id - String
issuerId - String
createdAt - DateTime
redeemedAt - DateTime
amount - Int
Example
{
  "id": "abc123",
  "issuerId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "redeemedAt": "2007-12-03T10:15:30Z",
  "amount": 987
}
Types

Date

Description

A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Example
"2007-12-03"
Types

DateTime

Description

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Example
"2007-12-03T10:15:30Z"
Types

EnvironmentVariable

Fields
Field Name Description
key - String
value - String
Example
{
  "key": "abc123",
  "value": "abc123"
}
Types

EnvironmentVariableInput

Fields
Input Field Description
key - String!
value - String!
Example
{
  "key": "abc123",
  "value": "xyz789"
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

Gpu

Fields
Field Name Description
id - String!
podId - String
Example
{
  "id": "xyz789",
  "podId": "xyz789"
}
Types

GpuLowestPriceInput

Fields
Input Field Description
gpuCount - Int!
totalDisk - Int
minMemoryInGb - Int
minVcpuCount - Int
secureCloud - Boolean
minDownload - Int
minUpload - Int
countryCode - String
supportPublicIp - Boolean
Example
{
  "gpuCount": 123,
  "totalDisk": 123,
  "minMemoryInGb": 123,
  "minVcpuCount": 123,
  "secureCloud": false,
  "minDownload": 987,
  "minUpload": 987,
  "countryCode": "xyz789",
  "supportPublicIp": true
}
Types

GpuTelemetry

Fields
Field Name Description
id - String
percentUtilization - Float
temperatureCelcius - Float
memoryUtilization - Float
powerWatts - Float
Example
{
  "id": "abc123",
  "percentUtilization": 987.65,
  "temperatureCelcius": 123.45,
  "memoryUtilization": 123.45,
  "powerWatts": 123.45
}
Types

GpuType

Fields
Field Name Description
lowestPrice - LowestPrice
Arguments
input - GpuLowestPriceInput
maxGpuCount - Int
id - String
displayName - String
manufacturer - String
memoryInGb - Int
cudaCores - Int
secureCloud - Boolean
communityCloud - Boolean
securePrice - Float
communityPrice - Float
Example
{
  "lowestPrice": LowestPrice,
  "maxGpuCount": 987,
  "id": "abc123",
  "displayName": "xyz789",
  "manufacturer": "xyz789",
  "memoryInGb": 987,
  "cudaCores": 987,
  "secureCloud": true,
  "communityCloud": true,
  "securePrice": 123.45,
  "communityPrice": 123.45
}
Types

GpuTypeFilter

Fields
Input Field Description
id - String
ids - [String!]
Example
{
  "id": "abc123",
  "ids": ["abc123"]
}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

LowestPrice

Fields
Field Name Description
gpuName - String
gpuTypeId - String
minimumBidPrice - Float
uninterruptablePrice - Float
minMemory - Int
minVcpu - Int
rentalPercentage - Float
rentedCount - Int
totalCount - Int
stockStatus - String
minDownload - Int
minUpload - Int
countryCode - String
supportPublicIp - Boolean
Example
{
  "gpuName": "abc123",
  "gpuTypeId": "abc123",
  "minimumBidPrice": 987.65,
  "uninterruptablePrice": 123.45,
  "minMemory": 987,
  "minVcpu": 987,
  "rentalPercentage": 987.65,
  "rentedCount": 123,
  "totalCount": 123,
  "stockStatus": "abc123",
  "minDownload": 123,
  "minUpload": 123,
  "countryCode": "xyz789",
  "supportPublicIp": true
}
Types

Machine

Fields
Field Name Description
pods - [Pod]
id - String
userId - String
name - String
registered - Boolean
gpuTypeId - String
gpuType - GpuType
gpuPowerLimitPercentageRented - Int
gpuPowerLimitPercentageSelf - Int
cpuCount - Int
cpuTypeId - String
cpuType - CpuType
moboName - String
hostPricePerGpu - Float
hostMinBidPerGpu - Float
defaultImageName - String
defaultStartScript - String
defaultArguments - String
defaultDiskInGb - Int
defaultPort - Port
defaultEnv - [String]
location - String
listed - Boolean
verified - Boolean
machineId - String
diskReserved - Int
diskTotal - Int
diskMBps - Int
downloadMbps - Int
gpuReserved - Int
gpuTotal - Int
pcieLink - Int
pcieLinkWidth - Int
memoryReserved - Int
memoryTotal - Int
uploadMbps - Int
vcpuReserved - Int
vcpuTotal - Int
installCert - String
uptimePercentListedOneWeek - Float
uptimePercentListedFourWeek - Float
uptimePercentListedTwelveWeek - Float
uptimePercentAbsoluteTwelveWeek - Float
margin - Float
gpuCloudPrice - Float
supportPublicIp - Boolean
secureCloud - Boolean
ownedByMe - Boolean
idleJobTemplateId - String
idleJobTemplate - PodTemplate
maintenanceStart - DateTime
maintenanceEnd - DateTime
maintenanceNote - String
note - String
machineBalance - MachineBalance
backgroundPodTelemetry - PodTelemetry
Arguments
input - backgroundPodTelemetryInput
latestTelemetry - MachineTelemetry
Example
{
  "pods": [Pod],
  "id": "xyz789",
  "userId": "abc123",
  "name": "abc123",
  "registered": true,
  "gpuTypeId": "abc123",
  "gpuType": GpuType,
  "gpuPowerLimitPercentageRented": 987,
  "gpuPowerLimitPercentageSelf": 123,
  "cpuCount": 123,
  "cpuTypeId": "xyz789",
  "cpuType": CpuType,
  "moboName": "xyz789",
  "hostPricePerGpu": 987.65,
  "hostMinBidPerGpu": 987.65,
  "defaultImageName": "abc123",
  "defaultStartScript": "abc123",
  "defaultArguments": "abc123",
  "defaultDiskInGb": 123,
  "defaultPort": 7100,
  "defaultEnv": ["abc123"],
  "location": "abc123",
  "listed": false,
  "verified": true,
  "machineId": "abc123",
  "diskReserved": 987,
  "diskTotal": 987,
  "diskMBps": 123,
  "downloadMbps": 987,
  "gpuReserved": 123,
  "gpuTotal": 123,
  "pcieLink": 987,
  "pcieLinkWidth": 123,
  "memoryReserved": 987,
  "memoryTotal": 987,
  "uploadMbps": 123,
  "vcpuReserved": 987,
  "vcpuTotal": 987,
  "installCert": "abc123",
  "uptimePercentListedOneWeek": 123.45,
  "uptimePercentListedFourWeek": 987.65,
  "uptimePercentListedTwelveWeek": 123.45,
  "uptimePercentAbsoluteTwelveWeek": 123.45,
  "margin": 987.65,
  "gpuCloudPrice": 987.65,
  "supportPublicIp": false,
  "secureCloud": false,
  "ownedByMe": true,
  "idleJobTemplateId": "xyz789",
  "idleJobTemplate": PodTemplate,
  "maintenanceStart": "2007-12-03T10:15:30Z",
  "maintenanceEnd": "2007-12-03T10:15:30Z",
  "maintenanceNote": "xyz789",
  "note": "abc123",
  "machineBalance": MachineBalance,
  "backgroundPodTelemetry": PodTelemetry,
  "latestTelemetry": MachineTelemetry
}
Types

MachineBalance

Fields
Field Name Description
hostDiskEarnings - Float
hostGpuEarnings - Float
hostTotalEarnings - Float
Example
{
  "hostDiskEarnings": 987.65,
  "hostGpuEarnings": 987.65,
  "hostTotalEarnings": 987.65
}
Types

MachineEarning

Fields
Field Name Description
date - DateTime
machineId - String
hostTotalEarnings - Float
hostGpuEarnings - Float
hostDiskEarnings - Float
Example
{
  "date": "2007-12-03T10:15:30Z",
  "machineId": "xyz789",
  "hostTotalEarnings": 123.45,
  "hostGpuEarnings": 987.65,
  "hostDiskEarnings": 987.65
}
Types

MachineTelemetry

Fields
Field Name Description
time - DateTime
cpuUtilization - Float
memoryUtilization - Float
averageGpuMetrics - GpuTelemetry
individualGpuMetrics - [GpuTelemetry]
Example
{
  "time": "2007-12-03T10:15:30Z",
  "cpuUtilization": 987.65,
  "memoryUtilization": 123.45,
  "averageGpuMetrics": GpuTelemetry,
  "individualGpuMetrics": [GpuTelemetry]
}
Types

Pod

Fields
Field Name Description
lowestBidPriceToResume - Float
apiKey - String
consumerUserId - String
containerDiskInGb - Int
containerRegistryAuthId - String
costMultiplier - Float
costPerHr - Float!
desiredStatus - PodStatus!
dockerArgs - String
dockerId - String
env - [String]
gpuCount - Int!
gpuPowerLimitPercent - Int!
gpus - [Gpu]!
id - String!
imageName - String!
lastStatusChange - String
locked - Boolean
machineId - String!
memoryInGb - Float!
name - String!
podType - PodType
port - Port
ports - String
registry - PodRegistry
templateId - String
uptimeSeconds - Int
vcpuCount - Float!
version - Int
volumeEncrypted - Boolean!
volumeInGb - Float
volumeKey - String
volumeMountPath - String
runtime - PodRuntime
machine - PodMachineInfo
latestTelemetry - PodTelemetry
Example
{
  "lowestBidPriceToResume": 123.45,
  "apiKey": "abc123",
  "consumerUserId": "abc123",
  "containerDiskInGb": 987,
  "containerRegistryAuthId": "xyz789",
  "costMultiplier": 987.65,
  "costPerHr": 123.45,
  "desiredStatus": "CREATED",
  "dockerArgs": "xyz789",
  "dockerId": "abc123",
  "env": ["abc123"],
  "gpuCount": 123,
  "gpuPowerLimitPercent": 987,
  "gpus": [Gpu],
  "id": "abc123",
  "imageName": "xyz789",
  "lastStatusChange": "xyz789",
  "locked": false,
  "machineId": "xyz789",
  "memoryInGb": 987.65,
  "name": "xyz789",
  "podType": "INTERRUPTABLE",
  "port": 7100,
  "ports": "xyz789",
  "registry": PodRegistry,
  "templateId": "xyz789",
  "uptimeSeconds": 987,
  "vcpuCount": 123.45,
  "version": 123,
  "volumeEncrypted": false,
  "volumeInGb": 123.45,
  "volumeKey": "abc123",
  "volumeMountPath": "abc123",
  "runtime": PodRuntime,
  "machine": PodMachineInfo,
  "latestTelemetry": PodTelemetry
}
Types

PodBidResumeInput

Fields
Input Field Description
podId - String!
gpuCount - Int!
bidPerGpu - Float!
Example
{
  "podId": "xyz789",
  "gpuCount": 123,
  "bidPerGpu": 123.45
}
Types

PodFilter

Fields
Input Field Description
podId - String!
Example
{"podId": "abc123"}
Types

PodFindAndDeployOnDemandInput

Fields
Input Field Description
gpuCount - Int
volumeInGb - Int
volumeKey - String
containerDiskInGb - Int
minVcpuCount - Int
minMemoryInGb - Int
gpuTypeId - String
cloudType - CloudTypeEnum
minUpload - Int
minDownload - Int
countryCode - String
supportPublicIp - Boolean
name - String
imageName - String
dockerArgs - String
deployCost - Float
port - Port
ports - String
stopAfter - DateTime
terminateAfter - DateTime
volumeMountPath - String
env - [EnvironmentVariableInput]
templateId - String
startJupyter - Boolean
startSsh - Boolean
Example
{
  "gpuCount": 987,
  "volumeInGb": 987,
  "volumeKey": "abc123",
  "containerDiskInGb": 123,
  "minVcpuCount": 987,
  "minMemoryInGb": 987,
  "gpuTypeId": "abc123",
  "cloudType": "SECURE",
  "minUpload": 123,
  "minDownload": 987,
  "countryCode": "abc123",
  "supportPublicIp": false,
  "name": "xyz789",
  "imageName": "xyz789",
  "dockerArgs": "xyz789",
  "deployCost": 123.45,
  "port": 7100,
  "ports": "xyz789",
  "stopAfter": "2007-12-03T10:15:30Z",
  "terminateAfter": "2007-12-03T10:15:30Z",
  "volumeMountPath": "xyz789",
  "env": [EnvironmentVariableInput],
  "templateId": "xyz789",
  "startJupyter": false,
  "startSsh": true
}
Types

PodMachineInfo

Fields
Field Name Description
costPerHr - Float
currentPricePerGpu - Float
diskMBps - Int
gpuAvailable - Int
gpuDisplayName - String
location - String
maintenanceEnd - DateTime
maintenanceNote - String
maintenanceStart - DateTime
maxDownloadSpeedMbps - Int
maxUploadSpeedMbps - Int
note - String
podHostId - String
secureCloud - Boolean
supportPublicIp - Boolean
Example
{
  "costPerHr": 123.45,
  "currentPricePerGpu": 123.45,
  "diskMBps": 123,
  "gpuAvailable": 987,
  "gpuDisplayName": "xyz789",
  "location": "abc123",
  "maintenanceEnd": "2007-12-03T10:15:30Z",
  "maintenanceNote": "xyz789",
  "maintenanceStart": "2007-12-03T10:15:30Z",
  "maxDownloadSpeedMbps": 123,
  "maxUploadSpeedMbps": 987,
  "note": "xyz789",
  "podHostId": "xyz789",
  "secureCloud": true,
  "supportPublicIp": false
}
Types

PodRegistry

Fields
Field Name Description
auth - String
pass - String
url - String
user - String
username - String
Example
{
  "auth": "xyz789",
  "pass": "abc123",
  "url": "xyz789",
  "user": "abc123",
  "username": "xyz789"
}
Types

PodRentInterruptableInput

Fields
Input Field Description
gpuCount - Int
volumeInGb - Int
volumeKey - String
containerDiskInGb - Int
minVcpuCount - Int
minMemoryInGb - Int
gpuTypeId - String
bidPerGpu - Float
cloudType - CloudTypeEnum
name - String
imageName - String
dockerArgs - String
port - Port
ports - String
stopAfter - String
terminateAfter - String
volumeMountPath - String
env - [EnvironmentVariableInput]
templateId - String
startJupyter - Boolean
startSsh - Boolean
minDownload - Int
minUpload - Int
countryCode - String
supportPublicIp - Boolean
Example
{
  "gpuCount": 987,
  "volumeInGb": 123,
  "volumeKey": "xyz789",
  "containerDiskInGb": 123,
  "minVcpuCount": 987,
  "minMemoryInGb": 987,
  "gpuTypeId": "xyz789",
  "bidPerGpu": 987.65,
  "cloudType": "SECURE",
  "name": "xyz789",
  "imageName": "xyz789",
  "dockerArgs": "abc123",
  "port": 7100,
  "ports": "xyz789",
  "stopAfter": "abc123",
  "terminateAfter": "abc123",
  "volumeMountPath": "xyz789",
  "env": [EnvironmentVariableInput],
  "templateId": "xyz789",
  "startJupyter": true,
  "startSsh": false,
  "minDownload": 987,
  "minUpload": 987,
  "countryCode": "xyz789",
  "supportPublicIp": true
}
Types

PodResumeInput

Fields
Input Field Description
podId - String!
gpuCount - Int
Example
{"podId": "xyz789", "gpuCount": 987}
Types

PodRuntime

Fields
Field Name Description
container - PodRuntimeContainer
gpus - [PodRuntimeGpus]
ports - [PodRuntimePorts]
uptimeInSeconds - Int
Example
{
  "container": PodRuntimeContainer,
  "gpus": [PodRuntimeGpus],
  "ports": [PodRuntimePorts],
  "uptimeInSeconds": 123
}
Types

PodRuntimeContainer

Fields
Field Name Description
cpuPercent - Int
memoryPercent - Int
Example
{"cpuPercent": 987, "memoryPercent": 987}
Types

PodRuntimeGpus

Fields
Field Name Description
id - String
gpuUtilPercent - Int
memoryUtilPercent - Int
Example
{
  "id": "abc123",
  "gpuUtilPercent": 987,
  "memoryUtilPercent": 987
}
Types

PodRuntimePorts

Fields
Field Name Description
ip - String
isIpPublic - Boolean
privatePort - Int
publicPort - Int
type - String
Example
{
  "ip": "abc123",
  "isIpPublic": false,
  "privatePort": 987,
  "publicPort": 123,
  "type": "xyz789"
}
Types

PodStatus

Values
Enum Value Description

CREATED

RUNNING

RESTARTING

EXITED

PAUSED

DEAD

TERMINATED
Example
"CREATED"
Types

PodStopInput

Fields
Input Field Description
podId - String!
Example
{"podId": "xyz789"}
Types

PodTelemetry

Fields
Field Name Description
state - String
time - DateTime
cpuUtilization - Float
memoryUtilization - Float
averageGpuMetrics - GpuTelemetry
individualGpuMetrics - [GpuTelemetry]
lastStateTransitionTimestamp - Int
Example
{
  "state": "xyz789",
  "time": "2007-12-03T10:15:30Z",
  "cpuUtilization": 123.45,
  "memoryUtilization": 987.65,
  "averageGpuMetrics": GpuTelemetry,
  "individualGpuMetrics": [GpuTelemetry],
  "lastStateTransitionTimestamp": 123
}
Types

PodTemplate

Fields
Field Name Description
advancedStart - Boolean
containerDiskInGb - Int
containerRegistryAuthId - String
dockerArgs - String
earned - Float
env - [EnvironmentVariable]
id - String
imageName - String
isPublic - Boolean
name - String
ports - String
readme - String
runtimeInMin - Int
startJupyter - Boolean
startScript - String
startSsh - Boolean
volumeInGb - Int
volumeMountPath - String
Example
{
  "advancedStart": true,
  "containerDiskInGb": 987,
  "containerRegistryAuthId": "xyz789",
  "dockerArgs": "xyz789",
  "earned": 987.65,
  "env": [EnvironmentVariable],
  "id": "abc123",
  "imageName": "abc123",
  "isPublic": true,
  "name": "abc123",
  "ports": "abc123",
  "readme": "xyz789",
  "runtimeInMin": 123,
  "startJupyter": true,
  "startScript": "xyz789",
  "startSsh": false,
  "volumeInGb": 987,
  "volumeMountPath": "abc123"
}
Types

PodTerminateInput

Fields
Input Field Description
podId - String!
Example
{"podId": "xyz789"}
Types

PodType

Values
Enum Value Description

INTERRUPTABLE

RESERVED

BID

BACKGROUND
Example
"INTERRUPTABLE"
Types

Port

Description

A field whose value is a valid TCP port within the range of 0 to 65535: https://en.wikipedia.org/wiki/Transmission_Control_Protocol#TCP_ports

Example
7100
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Types

StripeReloadTransaction

Fields
Field Name Description
id - String
mediumId - String
transactionCompletedAt - DateTime
receiptLink - String
amount - Float
medium - TransactionMedium
type - TransactionType
Example
{
  "id": "abc123",
  "mediumId": "abc123",
  "transactionCompletedAt": "2007-12-03T10:15:30Z",
  "receiptLink": "xyz789",
  "amount": 987.65,
  "medium": "STRIPE",
  "type": "RELOAD"
}
Types

TransactionMedium

Values
Enum Value Description

STRIPE

CRYPTO

RUNPOD
Example
"STRIPE"
Types

TransactionType

Values
Enum Value Description

RELOAD

CREDIT

DEBIT
Example
"RELOAD"
Types

User

Fields
Field Name Description
pods - [Pod]
machines - [Machine]
id - String
containerRegistryCreds - [ContainerRegistryAuth]
currentSpendPerHr - Float
machineQuota - Int
referralEarned - Float
signedTermsOfService - Boolean
spendLimit - Int
stripeSavedPaymentId - String
stripeSavedPaymentLast4 - String
templateEarned - Float
multiFactorEnabled - Boolean
machineEarnings - [MachineEarning]
clientBalance - Float
hostBalance - Float
hostStripeLinked - Boolean
stripeAccountId - String
stripeReloadHistory - [StripeReloadTransaction]
dailyCharges - [ClientCreditCharge]!
referral - UserReferral!
apiKeys - [ApiKey!]
pubKey - String
information - UserInformation
podTemplates - [PodTemplate]
creditCodes - [CreditCode]
Example
{
  "pods": [Pod],
  "machines": [Machine],
  "id": "xyz789",
  "containerRegistryCreds": [ContainerRegistryAuth],
  "currentSpendPerHr": 123.45,
  "machineQuota": 123,
  "referralEarned": 987.65,
  "signedTermsOfService": true,
  "spendLimit": 987,
  "stripeSavedPaymentId": "xyz789",
  "stripeSavedPaymentLast4": "xyz789",
  "templateEarned": 123.45,
  "multiFactorEnabled": true,
  "machineEarnings": [MachineEarning],
  "clientBalance": 987.65,
  "hostBalance": 987.65,
  "hostStripeLinked": false,
  "stripeAccountId": "abc123",
  "stripeReloadHistory": [StripeReloadTransaction],
  "dailyCharges": [ClientCreditCharge],
  "referral": UserReferral,
  "apiKeys": [ApiKey],
  "pubKey": "xyz789",
  "information": UserInformation,
  "podTemplates": [PodTemplate],
  "creditCodes": [CreditCode]
}
Types

UserInformation

Fields
Field Name Description
firstName - String
lastName - String
addressLine1 - String
addressLine2 - String
countryCode - String
companyName - String
companyIdentification - String
taxIdentification - String
Example
{
  "firstName": "xyz789",
  "lastName": "xyz789",
  "addressLine1": "xyz789",
  "addressLine2": "abc123",
  "countryCode": "xyz789",
  "companyName": "abc123",
  "companyIdentification": "abc123",
  "taxIdentification": "abc123"
}
Types

UserReferral

Fields
Field Name Description
code - String!
currentMonth - UserReferralMonth
Example
{
  "code": "xyz789",
  "currentMonth": UserReferralMonth
}
Types

UserReferralMonth

Fields
Field Name Description
totalReferrals - Int
totalSpend - Int
Example
{"totalReferrals": 123, "totalSpend": 123}
Types

Void

Description

Represents NULL values

Types

backgroundPodTelemetryInput

Fields
Input Field Description
machineId - String
gpuIndex - Int
Example
{"machineId": "xyz789", "gpuIndex": 987}