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": "xyz789",
        "displayName": "abc123",
        "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
    oneMonthPrice
    threeMonthPrice
    oneWeekPrice
    communitySpotPrice
    secureSpotPrice
  }
}
Variables
{"input": GpuTypeFilter}
Response
{
  "data": {
    "gpuTypes": [
      {
        "lowestPrice": LowestPrice,
        "maxGpuCount": 987,
        "id": "abc123",
        "displayName": "abc123",
        "manufacturer": "abc123",
        "memoryInGb": 123,
        "cudaCores": 987,
        "secureCloud": false,
        "communityCloud": false,
        "securePrice": 987.65,
        "communityPrice": 987.65,
        "oneMonthPrice": 987.65,
        "threeMonthPrice": 987.65,
        "oneWeekPrice": 987.65,
        "communitySpotPrice": 987.65,
        "secureSpotPrice": 987.65
      }
    ]
  }
}
Queries

myself

Response

Returns a User

Example

Query
query myself {
  myself {
    pods {
      ...PodFragment
    }
    machines {
      ...MachineFragment
    }
    id
    authId
    email
    containerRegistryCreds {
      ...ContainerRegistryAuthFragment
    }
    currentSpendPerHr
    machineQuota
    referralEarned
    signedTermsOfService
    spendLimit
    stripeSavedPaymentId
    stripeSavedPaymentLast4
    templateEarned
    multiFactorEnabled
    machineEarnings {
      ...MachineEarningFragment
    }
    underBalance
    minBalance
    stripeAutoReloadAmount
    stripeAutoPaymentThreshold
    serverlessDiscount {
      ...DiscountFragment
    }
    spendDetails {
      ...SpendDetailsFragment
    }
    clientBalance
    hostBalance
    hostStripeLinked
    stripeAccountId
    stripeReloadHistory {
      ...StripeReloadTransactionFragment
    }
    dailyCharges {
      ...ClientCreditChargeFragment
    }
    referral {
      ...UserReferralFragment
    }
    apiKeys {
      ...ApiKeyFragment
    }
    pubKey
    information {
      ...UserInformationFragment
    }
    notifyPodsStale
    notifyPodsGeneral
    notifyLowBalance
    creditAlertThreshold
    notifyOther
    podTemplates {
      ...PodTemplateFragment
    }
    creditCodes {
      ...CreditCodeFragment
    }
    maxServerlessConcurrency
    endpoint {
      ...EndpointFragment
    }
    endpoints {
      ...EndpointFragment
    }
    networkVolumes {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Response
{
  "data": {
    "myself": {
      "pods": [Pod],
      "machines": [Machine],
      "id": "xyz789",
      "authId": "abc123",
      "email": "xyz789",
      "containerRegistryCreds": [ContainerRegistryAuth],
      "currentSpendPerHr": 123.45,
      "machineQuota": 123,
      "referralEarned": 123.45,
      "signedTermsOfService": true,
      "spendLimit": 123,
      "stripeSavedPaymentId": "abc123",
      "stripeSavedPaymentLast4": "abc123",
      "templateEarned": 987.65,
      "multiFactorEnabled": true,
      "machineEarnings": [MachineEarning],
      "underBalance": true,
      "minBalance": 987.65,
      "stripeAutoReloadAmount": 987,
      "stripeAutoPaymentThreshold": 987,
      "serverlessDiscount": Discount,
      "spendDetails": SpendDetails,
      "clientBalance": 987.65,
      "hostBalance": 123.45,
      "hostStripeLinked": true,
      "stripeAccountId": "xyz789",
      "stripeReloadHistory": [StripeReloadTransaction],
      "dailyCharges": [ClientCreditCharge],
      "referral": UserReferral,
      "apiKeys": [ApiKey],
      "pubKey": "abc123",
      "information": UserInformation,
      "notifyPodsStale": true,
      "notifyPodsGeneral": true,
      "notifyLowBalance": false,
      "creditAlertThreshold": 987.65,
      "notifyOther": false,
      "podTemplates": [PodTemplate],
      "creditCodes": [CreditCode],
      "maxServerlessConcurrency": 123,
      "endpoint": Endpoint,
      "endpoints": [Endpoint],
      "networkVolumes": [NetworkVolume],
      "savingsPlans": [SavingsPlan]
    }
  }
}
Queries

pod

Response

Returns a Pod

Arguments
Name Description
input - PodFilter

Example

Query
query pod($input: PodFilter) {
  pod(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    adjustedCostPerHr
    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
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodFilter}
Response
{
  "data": {
    "pod": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "abc123",
      "apiKey": "abc123",
      "consumerUserId": "abc123",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "adjustedCostPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "xyz789",
      "env": ["abc123"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "abc123",
      "lastStatusChange": "xyz789",
      "locked": true,
      "machineId": "abc123",
      "memoryInGb": 123.45,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 65277,
      "ports": "abc123",
      "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,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}

Mutations

podBidResume

Response

Returns a Pod

Arguments
Name Description
input - PodBidResumeInput!

Example

Query
mutation podBidResume($input: PodBidResumeInput!) {
  podBidResume(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    adjustedCostPerHr
    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
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodBidResumeInput}
Response
{
  "data": {
    "podBidResume": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "abc123",
      "apiKey": "abc123",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "abc123",
      "costMultiplier": 987.65,
      "costPerHr": 123.45,
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "xyz789",
      "env": ["abc123"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "abc123",
      "lastStatusChange": "xyz789",
      "locked": true,
      "machineId": "xyz789",
      "memoryInGb": 123.45,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 65277,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 123,
      "vcpuCount": 987.65,
      "version": 987,
      "volumeEncrypted": false,
      "volumeInGb": 123.45,
      "volumeKey": "abc123",
      "volumeMountPath": "xyz789",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podEditJob

Response

Returns a Pod

Arguments
Name Description
input - PodEditJobInput!

Example

Query
mutation podEditJob($input: PodEditJobInput!) {
  podEditJob(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    adjustedCostPerHr
    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
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodEditJobInput}
Response
{
  "data": {
    "podEditJob": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "xyz789",
      "apiKey": "abc123",
      "consumerUserId": "abc123",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "abc123",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "xyz789",
      "env": ["xyz789"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "abc123",
      "lastStatusChange": "xyz789",
      "locked": true,
      "machineId": "abc123",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 65277,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 123.45,
      "version": 987,
      "volumeEncrypted": false,
      "volumeInGb": 987.65,
      "volumeKey": "xyz789",
      "volumeMountPath": "xyz789",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podFindAndDeployOnDemand

Response

Returns a Pod

Arguments
Name Description
input - PodFindAndDeployOnDemandInput

Example

Query
mutation podFindAndDeployOnDemand($input: PodFindAndDeployOnDemandInput) {
  podFindAndDeployOnDemand(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    adjustedCostPerHr
    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
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodFindAndDeployOnDemandInput}
Response
{
  "data": {
    "podFindAndDeployOnDemand": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "xyz789",
      "apiKey": "xyz789",
      "consumerUserId": "abc123",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "adjustedCostPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "abc123",
      "env": ["abc123"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "abc123",
      "lastStatusChange": "xyz789",
      "locked": false,
      "machineId": "xyz789",
      "memoryInGb": 987.65,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 65277,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 123.45,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 987.65,
      "volumeKey": "xyz789",
      "volumeMountPath": "abc123",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podRentInterruptable

Response

Returns a Pod

Arguments
Name Description
input - PodRentInterruptableInput!

Example

Query
mutation podRentInterruptable($input: PodRentInterruptableInput!) {
  podRentInterruptable(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    adjustedCostPerHr
    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
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodRentInterruptableInput}
Response
{
  "data": {
    "podRentInterruptable": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "xyz789",
      "apiKey": "abc123",
      "consumerUserId": "abc123",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 987.65,
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["abc123"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "abc123",
      "lastStatusChange": "abc123",
      "locked": false,
      "machineId": "xyz789",
      "memoryInGb": 123.45,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 65277,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 987,
      "vcpuCount": 987.65,
      "version": 987,
      "volumeEncrypted": false,
      "volumeInGb": 123.45,
      "volumeKey": "xyz789",
      "volumeMountPath": "abc123",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podResume

Response

Returns a Pod

Arguments
Name Description
input - PodResumeInput!

Example

Query
mutation podResume($input: PodResumeInput!) {
  podResume(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    adjustedCostPerHr
    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
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodResumeInput}
Response
{
  "data": {
    "podResume": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "abc123",
      "apiKey": "abc123",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["xyz789"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "xyz789",
      "lastStatusChange": "xyz789",
      "locked": true,
      "machineId": "xyz789",
      "memoryInGb": 123.45,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 65277,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 987,
      "vcpuCount": 123.45,
      "version": 987,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "xyz789",
      "volumeMountPath": "abc123",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podStop

Response

Returns a Pod

Arguments
Name Description
input - PodStopInput!

Example

Query
mutation podStop($input: PodStopInput!) {
  podStop(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    adjustedCostPerHr
    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
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodStopInput}
Response
{
  "data": {
    "podStop": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "xyz789",
      "apiKey": "abc123",
      "consumerUserId": "abc123",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "abc123",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "adjustedCostPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["abc123"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "abc123",
      "lastStatusChange": "abc123",
      "locked": false,
      "machineId": "xyz789",
      "memoryInGb": 123.45,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 65277,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 987,
      "vcpuCount": 123.45,
      "version": 987,
      "volumeEncrypted": false,
      "volumeInGb": 987.65,
      "volumeKey": "xyz789",
      "volumeMountPath": "xyz789",
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
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}}
Mutations

saveRegistryAuth

Response

Returns a ContainerRegistryAuth

Arguments
Name Description
input - SaveRegistryAuthInput

Example

Query
mutation saveRegistryAuth($input: SaveRegistryAuthInput) {
  saveRegistryAuth(input: $input) {
    id
    name
    userId
    registryAuth
  }
}
Variables
{"input": SaveRegistryAuthInput}
Response
{
  "data": {
    "saveRegistryAuth": {
      "id": "abc123",
      "name": "xyz789",
      "userId": "xyz789",
      "registryAuth": "xyz789"
    }
  }
}

Types

ApiKey

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

Boolean

Description

The Boolean scalar type represents true or false.

Types

ClientCreditCharge

Fields
Field Name Description
amount - Float
updatedAt - DateTime
diskCharges - Float
podCharges - Float
apiCharges - Float
serverlessCharges - Float
type - ClientCreditChargeType
Example
{
  "amount": 987.65,
  "updatedAt": "2007-12-03T10:15:30Z",
  "diskCharges": 123.45,
  "podCharges": 123.45,
  "apiCharges": 987.65,
  "serverlessCharges": 987.65,
  "type": "CHARGE_SERVERLESS"
}
Types

ClientCreditChargeType

Values
Enum Value Description

CHARGE_SERVERLESS

CHARGE_POD

CHARGE_API

CHARGE_STORAGE

CHARGE_SAVINGS_PLAN
Example
"CHARGE_SERVERLESS"
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": "abc123"
}
Types

CpuType

Fields
Field Name Description
id - String
displayName - String
manufacturer - String
cores - Int
threadsPerCore - Int
Example
{
  "id": "xyz789",
  "displayName": "abc123",
  "manufacturer": "xyz789",
  "cores": 123,
  "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

DataCenter

Fields
Field Name Description
id - String
name - String
location - String
storage - DataCenterStorage
storageSupport - Boolean
Example
{
  "id": "abc123",
  "name": "abc123",
  "location": "xyz789",
  "storage": DataCenterStorage,
  "storageSupport": true
}
Types

DataCenterStorage

Fields
Field Name Description
hostname - String
ips - [String]
pw - String
type - String
user - String
Example
{
  "hostname": "xyz789",
  "ips": ["xyz789"],
  "pw": "xyz789",
  "type": "xyz789",
  "user": "xyz789"
}
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

Discount

Fields
Field Name Description
id - Int!
userId - String!
type - DiscountType!
discountFactor - Float!
expirationDate - DateTime!
Example
{
  "id": 987,
  "userId": "xyz789",
  "type": "SERVERLESS",
  "discountFactor": 123.45,
  "expirationDate": "2007-12-03T10:15:30Z"
}
Types

DiscountType

Values
Enum Value Description

SERVERLESS
Example
"SERVERLESS"
Types

Endpoint

Fields
Field Name Description
aiKey - String
gpuIds - String
id - String
idleTimeout - Int
name - String
networkVolumeId - String
locations - String
pods - [Pod]
scalerType - String
scalerValue - Int
template - PodTemplate
templateId - String
type - String
userId - String
version - Int
workersMax - Int
workersMin - Int
workersStandby - Int
networkVolume - NetworkVolume
Example
{
  "aiKey": "xyz789",
  "gpuIds": "xyz789",
  "id": "abc123",
  "idleTimeout": 987,
  "name": "abc123",
  "networkVolumeId": "abc123",
  "locations": "xyz789",
  "pods": [Pod],
  "scalerType": "xyz789",
  "scalerValue": 987,
  "template": PodTemplate,
  "templateId": "abc123",
  "type": "xyz789",
  "userId": "abc123",
  "version": 123,
  "workersMax": 987,
  "workersMin": 123,
  "workersStandby": 987,
  "networkVolume": NetworkVolume
}
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": "xyz789",
  "value": "abc123"
}
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": "abc123"
}
Types

GpuLowestPriceInput

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

GpuTelemetry

Fields
Field Name Description
id - String
percentUtilization - Float
temperatureCelcius - Float
memoryUtilization - Float
powerWatts - Float
Example
{
  "id": "xyz789",
  "percentUtilization": 123.45,
  "temperatureCelcius": 987.65,
  "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
oneMonthPrice - Float
threeMonthPrice - Float
oneWeekPrice - Float
communitySpotPrice - Float
secureSpotPrice - Float
Example
{
  "lowestPrice": LowestPrice,
  "maxGpuCount": 123,
  "id": "abc123",
  "displayName": "abc123",
  "manufacturer": "abc123",
  "memoryInGb": 123,
  "cudaCores": 123,
  "secureCloud": false,
  "communityCloud": true,
  "securePrice": 987.65,
  "communityPrice": 123.45,
  "oneMonthPrice": 123.45,
  "threeMonthPrice": 987.65,
  "oneWeekPrice": 987.65,
  "communitySpotPrice": 987.65,
  "secureSpotPrice": 123.45
}
Types

GpuTypeFilter

Fields
Input Field Description
id - String
ids - [String!]
Example
{
  "id": "abc123",
  "ids": ["xyz789"]
}
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
123
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
minDisk - Int
minUpload - Int
countryCode - String
supportPublicIp - Boolean
Example
{
  "gpuName": "abc123",
  "gpuTypeId": "xyz789",
  "minimumBidPrice": 987.65,
  "uninterruptablePrice": 987.65,
  "minMemory": 123,
  "minVcpu": 987,
  "rentalPercentage": 123.45,
  "rentedCount": 123,
  "totalCount": 123,
  "stockStatus": "xyz789",
  "minDownload": 123,
  "minDisk": 123,
  "minUpload": 987,
  "countryCode": "xyz789",
  "supportPublicIp": false
}
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
dataCenter - DataCenter
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": "xyz789",
  "name": "abc123",
  "registered": true,
  "gpuTypeId": "abc123",
  "gpuType": GpuType,
  "gpuPowerLimitPercentageRented": 123,
  "gpuPowerLimitPercentageSelf": 987,
  "cpuCount": 987,
  "cpuTypeId": "xyz789",
  "cpuType": CpuType,
  "dataCenter": DataCenter,
  "moboName": "xyz789",
  "hostPricePerGpu": 987.65,
  "hostMinBidPerGpu": 123.45,
  "defaultImageName": "xyz789",
  "defaultStartScript": "xyz789",
  "defaultArguments": "abc123",
  "defaultDiskInGb": 123,
  "defaultPort": 65277,
  "defaultEnv": ["abc123"],
  "location": "abc123",
  "listed": true,
  "verified": true,
  "machineId": "xyz789",
  "diskReserved": 123,
  "diskTotal": 987,
  "diskMBps": 987,
  "downloadMbps": 123,
  "gpuReserved": 123,
  "gpuTotal": 123,
  "pcieLink": 123,
  "pcieLinkWidth": 123,
  "memoryReserved": 987,
  "memoryTotal": 987,
  "uploadMbps": 987,
  "vcpuReserved": 123,
  "vcpuTotal": 987,
  "installCert": "abc123",
  "uptimePercentListedOneWeek": 123.45,
  "uptimePercentListedFourWeek": 987.65,
  "uptimePercentListedTwelveWeek": 123.45,
  "uptimePercentAbsoluteTwelveWeek": 123.45,
  "margin": 123.45,
  "gpuCloudPrice": 123.45,
  "supportPublicIp": false,
  "secureCloud": false,
  "ownedByMe": true,
  "idleJobTemplateId": "xyz789",
  "idleJobTemplate": PodTemplate,
  "maintenanceStart": "2007-12-03T10:15:30Z",
  "maintenanceEnd": "2007-12-03T10:15:30Z",
  "maintenanceNote": "abc123",
  "note": "xyz789",
  "machineBalance": MachineBalance,
  "backgroundPodTelemetry": PodTelemetry,
  "latestTelemetry": MachineTelemetry
}
Types

MachineBalance

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

MachineEarning

Fields
Field Name Description
name - String
date - DateTime
machineId - String
hostTotalEarnings - Float
hostGpuEarnings - Float
hostDiskEarnings - Float
Example
{
  "name": "abc123",
  "date": "2007-12-03T10:15:30Z",
  "machineId": "abc123",
  "hostTotalEarnings": 987.65,
  "hostGpuEarnings": 123.45,
  "hostDiskEarnings": 123.45
}
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

NetworkVolume

Fields
Field Name Description
id - String
name - String
size - Int
dataCenterId - String
dataCenter - DataCenter
Example
{
  "id": "xyz789",
  "name": "abc123",
  "size": 987,
  "dataCenterId": "xyz789",
  "dataCenter": DataCenter
}
Types

Pod

Fields
Field Name Description
lowestBidPriceToResume - Float
aiApiId - String
apiKey - String
consumerUserId - String
containerDiskInGb - Int
containerRegistryAuthId - String
costMultiplier - Float
costPerHr - Float!
adjustedCostPerHr - 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
endpoint - Endpoint
networkVolume - NetworkVolume
savingsPlans - [SavingsPlan]
Example
{
  "lowestBidPriceToResume": 123.45,
  "aiApiId": "xyz789",
  "apiKey": "abc123",
  "consumerUserId": "xyz789",
  "containerDiskInGb": 123,
  "containerRegistryAuthId": "xyz789",
  "costMultiplier": 123.45,
  "costPerHr": 987.65,
  "adjustedCostPerHr": 987.65,
  "desiredStatus": "CREATED",
  "dockerArgs": "abc123",
  "dockerId": "xyz789",
  "env": ["abc123"],
  "gpuCount": 123,
  "gpuPowerLimitPercent": 987,
  "gpus": [Gpu],
  "id": "xyz789",
  "imageName": "abc123",
  "lastStatusChange": "abc123",
  "locked": false,
  "machineId": "xyz789",
  "memoryInGb": 987.65,
  "name": "xyz789",
  "podType": "INTERRUPTABLE",
  "port": 65277,
  "ports": "abc123",
  "registry": PodRegistry,
  "templateId": "xyz789",
  "uptimeSeconds": 123,
  "vcpuCount": 987.65,
  "version": 987,
  "volumeEncrypted": false,
  "volumeInGb": 987.65,
  "volumeKey": "abc123",
  "volumeMountPath": "abc123",
  "runtime": PodRuntime,
  "machine": PodMachineInfo,
  "latestTelemetry": PodTelemetry,
  "endpoint": Endpoint,
  "networkVolume": NetworkVolume,
  "savingsPlans": [SavingsPlan]
}
Types

PodBidResumeInput

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

PodEditJobInput

Fields
Input Field Description
podId - String!
dockerArgs - String
imageName - String!
env - [EnvironmentVariableInput]
port - Port
ports - String
containerDiskInGb - Int!
volumeInGb - Int
volumeMountPath - String
containerRegistryAuthId - String
Example
{
  "podId": "xyz789",
  "dockerArgs": "abc123",
  "imageName": "xyz789",
  "env": [EnvironmentVariableInput],
  "port": 65277,
  "ports": "xyz789",
  "containerDiskInGb": 987,
  "volumeInGb": 987,
  "volumeMountPath": "abc123",
  "containerRegistryAuthId": "xyz789"
}
Types

PodFilter

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

PodFindAndDeployOnDemandInput

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

PodMachineInfo

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

PodRegistry

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

PodRentInterruptableInput

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

PodResumeInput

Fields
Input Field Description
podId - String!
gpuCount - Int
Example
{"podId": "abc123", "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": 123, "memoryPercent": 123}
Types

PodRuntimeGpus

Fields
Field Name Description
id - String
gpuUtilPercent - Int
memoryUtilPercent - Int
Example
{
  "id": "xyz789",
  "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": 987,
  "type": "abc123"
}
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": "abc123",
  "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
isRunpod - Boolean
isServerless - Boolean
name - String
ports - String
readme - String
runtimeInMin - Int
startJupyter - Boolean
startScript - String
startSsh - Boolean
volumeInGb - Int
volumeMountPath - String
Example
{
  "advancedStart": false,
  "containerDiskInGb": 987,
  "containerRegistryAuthId": "abc123",
  "dockerArgs": "abc123",
  "earned": 123.45,
  "env": [EnvironmentVariable],
  "id": "xyz789",
  "imageName": "abc123",
  "isPublic": false,
  "isRunpod": true,
  "isServerless": true,
  "name": "xyz789",
  "ports": "abc123",
  "readme": "xyz789",
  "runtimeInMin": 123,
  "startJupyter": true,
  "startScript": "abc123",
  "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
65277
Types

SaveRegistryAuthInput

Fields
Input Field Description
name - String!
username - String!
password - String!
Example
{
  "name": "abc123",
  "username": "abc123",
  "password": "abc123"
}
Types

SavingsPlan

Fields
Field Name Description
endTime - DateTime
startTime - DateTime
gpuType - GpuType
podId - String
gpuTypeId - String
pod - Pod
savingsPlanType - String
costPerHr - Float
upfrontCost - Float
planLength - String
Example
{
  "endTime": "2007-12-03T10:15:30Z",
  "startTime": "2007-12-03T10:15:30Z",
  "gpuType": GpuType,
  "podId": "abc123",
  "gpuTypeId": "xyz789",
  "pod": Pod,
  "savingsPlanType": "xyz789",
  "costPerHr": 987.65,
  "upfrontCost": 987.65,
  "planLength": "xyz789"
}
Types

SavingsPlanInput

Fields
Input Field Description
planLength - String
upfrontCost - Float
Example
{
  "planLength": "abc123",
  "upfrontCost": 123.45
}
Types

SpendDetails

Fields
Field Name Description
localStoragePerHour - Float
networkStoragePerHour - Float
gpuComputePerHour - Float
Example
{
  "localStoragePerHour": 123.45,
  "networkStoragePerHour": 123.45,
  "gpuComputePerHour": 987.65
}
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": "xyz789",
  "mediumId": "xyz789",
  "transactionCompletedAt": "2007-12-03T10:15:30Z",
  "receiptLink": "xyz789",
  "amount": 987.65,
  "medium": "STRIPE",
  "type": "RELOAD"
}
Types

TransactionMedium

Values
Enum Value Description

STRIPE

CRYPTO

RUNPOD

COINBASE

WIRE

REFERRAL
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
authId - String
email - String
containerRegistryCreds - [ContainerRegistryAuth]
currentSpendPerHr - Float
machineQuota - Int
referralEarned - Float
signedTermsOfService - Boolean
spendLimit - Int
stripeSavedPaymentId - String
stripeSavedPaymentLast4 - String
templateEarned - Float
multiFactorEnabled - Boolean
machineEarnings - [MachineEarning]
underBalance - Boolean
minBalance - Float
stripeAutoReloadAmount - Int
stripeAutoPaymentThreshold - Int
serverlessDiscount - Discount
spendDetails - SpendDetails
clientBalance - Float
hostBalance - Float
hostStripeLinked - Boolean
stripeAccountId - String
stripeReloadHistory - [StripeReloadTransaction]
dailyCharges - [ClientCreditCharge]!
referral - UserReferral!
apiKeys - [ApiKey!]
pubKey - String
information - UserInformation
notifyPodsStale - Boolean
notifyPodsGeneral - Boolean
notifyLowBalance - Boolean
creditAlertThreshold - Float
notifyOther - Boolean
podTemplates - [PodTemplate]
creditCodes - [CreditCode]
maxServerlessConcurrency - Int
endpoint - Endpoint
Arguments
id - String!
endpoints - [Endpoint]!
networkVolumes - [NetworkVolume]
savingsPlans - [SavingsPlan]
Example
{
  "pods": [Pod],
  "machines": [Machine],
  "id": "abc123",
  "authId": "xyz789",
  "email": "abc123",
  "containerRegistryCreds": [ContainerRegistryAuth],
  "currentSpendPerHr": 987.65,
  "machineQuota": 987,
  "referralEarned": 987.65,
  "signedTermsOfService": false,
  "spendLimit": 987,
  "stripeSavedPaymentId": "xyz789",
  "stripeSavedPaymentLast4": "abc123",
  "templateEarned": 987.65,
  "multiFactorEnabled": false,
  "machineEarnings": [MachineEarning],
  "underBalance": false,
  "minBalance": 123.45,
  "stripeAutoReloadAmount": 123,
  "stripeAutoPaymentThreshold": 123,
  "serverlessDiscount": Discount,
  "spendDetails": SpendDetails,
  "clientBalance": 987.65,
  "hostBalance": 123.45,
  "hostStripeLinked": false,
  "stripeAccountId": "xyz789",
  "stripeReloadHistory": [StripeReloadTransaction],
  "dailyCharges": [ClientCreditCharge],
  "referral": UserReferral,
  "apiKeys": [ApiKey],
  "pubKey": "abc123",
  "information": UserInformation,
  "notifyPodsStale": false,
  "notifyPodsGeneral": true,
  "notifyLowBalance": true,
  "creditAlertThreshold": 123.45,
  "notifyOther": false,
  "podTemplates": [PodTemplate],
  "creditCodes": [CreditCode],
  "maxServerlessConcurrency": 987,
  "endpoint": Endpoint,
  "endpoints": [Endpoint],
  "networkVolumes": [NetworkVolume],
  "savingsPlans": [SavingsPlan]
}
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": "abc123",
  "addressLine2": "xyz789",
  "countryCode": "abc123",
  "companyName": "xyz789",
  "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": 987, "totalSpend": 987}
Types

Void

Description

Represents NULL values

Types

backgroundPodTelemetryInput

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