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

Headers

Authorization: Bearer <RUNPOD_API_KEY>

Version

1.1.0

Queries

`cpuTypes`

Response

Returns [CpuType]

Example

Query

query cpuTypes {
  cpuTypes {
    id
    displayName
    manufacturer
    cores
    threadsPerCore
    groupId
  }
}

Response

{
  "data": {
    "cpuTypes": [
      {
        "id": "xyz789",
        "displayName": "abc123",
        "manufacturer": "abc123",
        "cores": 987,
        "threadsPerCore": 987,
        "groupId": "abc123"
      }
    ]
  }
}

Queries

`gpuTypes`

Response

Returns [GpuType]

Arguments

Name	Description
`input` - `GpuTypeFilter`

Example

Query

query gpuTypes($input: GpuTypeFilter) {
  gpuTypes(input: $input) {
    lowestPrice {
      ...LowestPriceFragment
    }
    maxGpuCount
    maxGpuCountCommunityCloud
    maxGpuCountSecureCloud
    minPodGpuCount
    nodeGroupGpuSizes
    nodeGroupDatacenters {
      ...DataCenterFragment
    }
    id
    displayName
    manufacturer
    memoryInGb
    cudaCores
    secureCloud
    communityCloud
    securePrice
    clusterPrice
    communityPrice
    oneMonthPrice
    threeMonthPrice
    sixMonthPrice
    oneYearPrice
    oneWeekPrice
    communitySpotPrice
    secureSpotPrice
    throughput
  }
}

Variables

{"input": GpuTypeFilter}

Response

{
  "data": {
    "gpuTypes": [
      {
        "lowestPrice": LowestPrice,
        "maxGpuCount": 123,
        "maxGpuCountCommunityCloud": 987,
        "maxGpuCountSecureCloud": 123,
        "minPodGpuCount": 987,
        "nodeGroupGpuSizes": [987],
        "nodeGroupDatacenters": [DataCenter],
        "id": "xyz789",
        "displayName": "xyz789",
        "manufacturer": "abc123",
        "memoryInGb": 987,
        "cudaCores": 987,
        "secureCloud": true,
        "communityCloud": true,
        "securePrice": 123.45,
        "clusterPrice": 123.45,
        "communityPrice": 987.65,
        "oneMonthPrice": 123.45,
        "threeMonthPrice": 123.45,
        "sixMonthPrice": 987.65,
        "oneYearPrice": 987.65,
        "oneWeekPrice": 123.45,
        "communitySpotPrice": 987.65,
        "secureSpotPrice": 987.65,
        "throughput": 987
      }
    ]
  }
}

Queries

`myself`

Response

Returns a User

Example

Query

query myself {
  myself {
    pods {
      ...PodFragment
    }
    backgroundPods {
      ...PodFragment
    }
    podsConnection {
      ...PodsConnectionFragment
    }
    machines {
      ...MachineFragment
    }
    hiddenMachines {
      ...MachineFragment
    }
    machinesSummary {
      ...MachineSummaryFragment
    }
    id
    authId
    email
    containerRegistryCreds {
      ...ContainerRegistryAuthFragment
    }
    currentSpendPerHr
    machineQuota
    referralEarned
    signedTermsOfService
    spendLimit
    stripeSavedPaymentId
    stripeSavedPaymentLast4
    templateEarned
    multiFactorEnabled
    machineEarnings {
      ...MachineEarningFragment
    }
    machineEarningsCustomRange {
      ...MachineEarningFragment
    }
    networkStorageEarnings {
      ...NetworkStorageEarningFragment
    }
    underBalance
    minBalance
    stripeAutoReloadAmount
    stripeAutoPaymentThreshold
    spendDetails {
      ...SpendDetailsFragment
    }
    maxServerlessConcurrency
    clientLifetimeSpend
    referralId
    datacenters {
      ...DataCenterFragment
    }
    githubAccountInfo {
      ...GithubAccountInfoFragment
    }
    discordAccountInfo {
      ...DiscordAccountInfoFragment
    }
    isAutoPayEnabled
    enableBackupPayments
    onboardingInfo {
      ...OnboardingInfoFragment
    }
    affiliateKey
    hasActivated
    canRefer
    referralUsageId
    activeMigrations {
      ...PodMigrationFragment
    }
    notifyCcList
    userPreferences {
      ...UserPreferenceFragment
    }
    clientBalance
    hostBalance
    hostStripeLinked
    stripeAccountId
    stripeReloadHistory {
      ...StripeReloadTransactionFragment
    }
    payoutHistory {
      ...PayoutHistoryFragment
    }
    dailyCharges {
      ...ClientCreditChargeFragment
    }
    referral {
      ...UserReferralFragment
    }
    pubKey
    information {
      ...UserInformationFragment
    }
    notifyPodsStale
    notifyPodsGeneral
    notifyLowBalance
    creditAlertThreshold
    notifyOther
    podTemplates {
      ...PodTemplateFragment
    }
    creditCodes {
      ...CreditCodeFragment
    }
    endpoint {
      ...EndpointFragment
    }
    endpoints {
      ...EndpointFragment
    }
    networkVolumes {
      ...NetworkVolumeFragment
    }
    teams {
      ...TeamFragment
    }
    ownedTeams {
      ...TeamFragment
    }
    team {
      ...TeamFragment
    }
    teamMembership {
      ...TeamMembershipFragment
    }
    teamScopes {
      ...TeamScopesFragment
    }
    isTeam
    savingsPlans {
      ...SavingsPlanFragment
    }
    savingsPlan {
      ...SavingsPlanFragment
    }
    serverlessDiscount {
      ...DiscountFragment
    }
    serverlessDiscounts {
      ...DiscountFragment
    }
    billing {
      ...UserBillingFragment
    }
    secrets {
      ...SecretFragment
    }
    impersonations {
      ...ImpersonationFragment
    }
    activeImpersonation {
      ...ImpersonationFragment
    }
    nodeGroups {
      ...NodeGroupFragment
    }
    cluster {
      ...ClusterFragment
    }
    clusters {
      ...ClusterFragment
    }
    apiKeys {
      ...ApiKeyFragment
    }
    sharedApiKeys {
      ...SharedApiKeyFragment
    }
    paymentMethods {
      ...PaymentMethodFragment
    }
    paymentMethodsByPriority {
      ...PaymentMethodFragment
    }
    defaultPaymentMethod {
      ...PaymentMethodFragment
    }
    reservations {
      ...UserReservationFragment
    }
  }
}

Response

{
  "data": {
    "myself": {
      "pods": [Pod],
      "backgroundPods": [Pod],
      "podsConnection": PodsConnection,
      "machines": [Machine],
      "hiddenMachines": [Machine],
      "machinesSummary": [MachineSummary],
      "id": "abc123",
      "authId": "abc123",
      "email": "abc123",
      "containerRegistryCreds": [ContainerRegistryAuth],
      "currentSpendPerHr": 987.65,
      "machineQuota": 123,
      "referralEarned": 987.65,
      "signedTermsOfService": true,
      "spendLimit": 123,
      "stripeSavedPaymentId": "abc123",
      "stripeSavedPaymentLast4": "abc123",
      "templateEarned": 123.45,
      "multiFactorEnabled": true,
      "machineEarnings": [MachineEarning],
      "machineEarningsCustomRange": [MachineEarning],
      "networkStorageEarnings": [NetworkStorageEarning],
      "underBalance": false,
      "minBalance": 987.65,
      "stripeAutoReloadAmount": 123,
      "stripeAutoPaymentThreshold": 987,
      "spendDetails": SpendDetails,
      "maxServerlessConcurrency": 123,
      "clientLifetimeSpend": 123.45,
      "referralId": "xyz789",
      "datacenters": [DataCenter],
      "githubAccountInfo": GithubAccountInfo,
      "discordAccountInfo": DiscordAccountInfo,
      "isAutoPayEnabled": false,
      "enableBackupPayments": false,
      "onboardingInfo": OnboardingInfo,
      "affiliateKey": "xyz789",
      "hasActivated": true,
      "canRefer": true,
      "referralUsageId": "abc123",
      "activeMigrations": [PodMigration],
      "notifyCcList": "xyz789",
      "userPreferences": [UserPreference],
      "clientBalance": 987.65,
      "hostBalance": 123.45,
      "hostStripeLinked": true,
      "stripeAccountId": "abc123",
      "stripeReloadHistory": [StripeReloadTransaction],
      "payoutHistory": [PayoutHistory],
      "dailyCharges": [ClientCreditCharge],
      "referral": UserReferral,
      "pubKey": "abc123",
      "information": UserInformation,
      "notifyPodsStale": false,
      "notifyPodsGeneral": false,
      "notifyLowBalance": false,
      "creditAlertThreshold": 123.45,
      "notifyOther": true,
      "podTemplates": [PodTemplate],
      "creditCodes": [CreditCode],
      "endpoint": Endpoint,
      "endpoints": [Endpoint],
      "networkVolumes": [NetworkVolume],
      "teams": [Team],
      "ownedTeams": [Team],
      "team": Team,
      "teamMembership": TeamMembership,
      "teamScopes": TeamScopes,
      "isTeam": false,
      "savingsPlans": [SavingsPlan],
      "savingsPlan": SavingsPlan,
      "serverlessDiscount": Discount,
      "serverlessDiscounts": [Discount],
      "billing": UserBilling,
      "secrets": [Secret],
      "impersonations": [Impersonation],
      "activeImpersonation": Impersonation,
      "nodeGroups": [NodeGroup],
      "cluster": Cluster,
      "clusters": [Cluster],
      "apiKeys": [ApiKey],
      "sharedApiKeys": [SharedApiKey],
      "paymentMethods": [PaymentMethod],
      "paymentMethodsByPriority": [PaymentMethod],
      "defaultPaymentMethod": PaymentMethod,
      "reservations": [UserReservation]
    }
  }
}

Queries

`pod`

Response

Returns a Pod

Arguments

Name	Description
`input` - `PodFilter`

Example

Query

query pod($input: PodFilter) {
  pod(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    clusterIp
    clusterIdx
    clusterCidr
    clusterRole
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    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
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    testPod
    ideAiApiId
    hubReleaseId
    hubRelease {
      ...HubReleaseFragment
    }
    modelVersions {
      ...ModelVersionPodAssignmentFragment
    }
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
    clusterId
    ipAddress {
      ...IPAddressFragment
    }
    models
  }
}

Variables

{"input": PodFilter}

Response

{
  "data": {
    "pod": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "abc123",
      "apiKey": "abc123",
      "clusterIp": "xyz789",
      "clusterIdx": 987,
      "clusterCidr": "xyz789",
      "clusterRole": "SLURM_CONTROLLER",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "abc123",
      "costMultiplier": 987.65,
      "costPerHr": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "abc123",
      "env": ["abc123"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "xyz789",
      "lastStatusChange": "abc123",
      "locked": true,
      "machineId": "xyz789",
      "memoryInGb": 123.45,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 43612,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 123.45,
      "version": 987,
      "volumeEncrypted": false,
      "volumeInGb": 987.65,
      "volumeKey": "xyz789",
      "volumeMountPath": "abc123",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "abc123",
      "machineType": "xyz789",
      "slsVersion": 987,
      "networkVolumeId": "abc123",
      "testPod": false,
      "ideAiApiId": "xyz789",
      "hubReleaseId": "xyz789",
      "hubRelease": HubRelease,
      "modelVersions": [ModelVersionPodAssignment],
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan],
      "clusterId": "abc123",
      "ipAddress": IPAddress,
      "models": ["xyz789"]
    }
  }
}

Mutations

`createCluster`

Response

Returns a Cluster!

Arguments

Name	Description
`input` - `CreateClusterInput!`

Example

Query

mutation createCluster($input: CreateClusterInput!) {
  createCluster(input: $input) {
    id
    name
    userId
    gpuTypeId
    gpuDisplayName
    podCount
    gpuCountPerPod
    type
    templateId
    createdAt
    pods {
      ...PodFragment
    }
  }
}

Variables

{"input": CreateClusterInput}

Response

{
  "data": {
    "createCluster": {
      "id": "xyz789",
      "name": "xyz789",
      "userId": "xyz789",
      "gpuTypeId": "xyz789",
      "gpuDisplayName": "xyz789",
      "podCount": 987,
      "gpuCountPerPod": 987,
      "type": "APPLICATION",
      "templateId": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "pods": [Pod]
    }
  }
}

Mutations

`deleteCluster`

Response

Returns a Void

Arguments

Name	Description
`input` - `DeleteClusterInput!`

Example

Query

mutation deleteCluster($input: DeleteClusterInput!) {
  deleteCluster(input: $input)
}

Variables

{"input": DeleteClusterInput}

Response

{"data": {"deleteCluster": null}}

Mutations

`podBidResume`

Response

Returns a Pod

Arguments

Name	Description
`input` - `PodBidResumeInput!`

Example

Query

mutation podBidResume($input: PodBidResumeInput!) {
  podBidResume(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    clusterIp
    clusterIdx
    clusterCidr
    clusterRole
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    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
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    testPod
    ideAiApiId
    hubReleaseId
    hubRelease {
      ...HubReleaseFragment
    }
    modelVersions {
      ...ModelVersionPodAssignmentFragment
    }
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
    clusterId
    ipAddress {
      ...IPAddressFragment
    }
    models
  }
}

Variables

{"input": PodBidResumeInput}

Response

{
  "data": {
    "podBidResume": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "abc123",
      "apiKey": "xyz789",
      "clusterIp": "abc123",
      "clusterIdx": 123,
      "clusterCidr": "abc123",
      "clusterRole": "SLURM_CONTROLLER",
      "consumerUserId": "abc123",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 987.65,
      "costPerHr": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "abc123",
      "env": ["abc123"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "xyz789",
      "lastStatusChange": "abc123",
      "locked": true,
      "machineId": "abc123",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 43612,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 123,
      "vcpuCount": 123.45,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 987.65,
      "volumeKey": "xyz789",
      "volumeMountPath": "xyz789",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "abc123",
      "machineType": "xyz789",
      "slsVersion": 123,
      "networkVolumeId": "xyz789",
      "testPod": false,
      "ideAiApiId": "abc123",
      "hubReleaseId": "abc123",
      "hubRelease": HubRelease,
      "modelVersions": [ModelVersionPodAssignment],
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan],
      "clusterId": "xyz789",
      "ipAddress": IPAddress,
      "models": ["abc123"]
    }
  }
}

Mutations

`podEditJob`

Response

Returns a Pod

Arguments

Name	Description
`input` - `PodEditJobInput!`

Example

Query

mutation podEditJob($input: PodEditJobInput!) {
  podEditJob(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    clusterIp
    clusterIdx
    clusterCidr
    clusterRole
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    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
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    testPod
    ideAiApiId
    hubReleaseId
    hubRelease {
      ...HubReleaseFragment
    }
    modelVersions {
      ...ModelVersionPodAssignmentFragment
    }
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
    clusterId
    ipAddress {
      ...IPAddressFragment
    }
    models
  }
}

Variables

{"input": PodEditJobInput}

Response

{
  "data": {
    "podEditJob": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "abc123",
      "apiKey": "abc123",
      "clusterIp": "abc123",
      "clusterIdx": 987,
      "clusterCidr": "abc123",
      "clusterRole": "SLURM_CONTROLLER",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["xyz789"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "xyz789",
      "lastStatusChange": "abc123",
      "locked": false,
      "machineId": "xyz789",
      "memoryInGb": 123.45,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 43612,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 987.65,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 987.65,
      "volumeKey": "abc123",
      "volumeMountPath": "abc123",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "xyz789",
      "slsVersion": 987,
      "networkVolumeId": "xyz789",
      "testPod": false,
      "ideAiApiId": "xyz789",
      "hubReleaseId": "xyz789",
      "hubRelease": HubRelease,
      "modelVersions": [ModelVersionPodAssignment],
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan],
      "clusterId": "xyz789",
      "ipAddress": IPAddress,
      "models": ["xyz789"]
    }
  }
}

Mutations

`podFindAndDeployOnDemand`

Response

Returns a Pod

Arguments

Name	Description
`input` - `PodFindAndDeployOnDemandInput`

Example

Query

mutation podFindAndDeployOnDemand($input: PodFindAndDeployOnDemandInput) {
  podFindAndDeployOnDemand(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    clusterIp
    clusterIdx
    clusterCidr
    clusterRole
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    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
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    testPod
    ideAiApiId
    hubReleaseId
    hubRelease {
      ...HubReleaseFragment
    }
    modelVersions {
      ...ModelVersionPodAssignmentFragment
    }
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
    clusterId
    ipAddress {
      ...IPAddressFragment
    }
    models
  }
}

Variables

{"input": PodFindAndDeployOnDemandInput}

Response

{
  "data": {
    "podFindAndDeployOnDemand": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "xyz789",
      "apiKey": "abc123",
      "clusterIp": "xyz789",
      "clusterIdx": 987,
      "clusterCidr": "xyz789",
      "clusterRole": "SLURM_CONTROLLER",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 987.65,
      "costPerHr": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "abc123",
      "env": ["xyz789"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "xyz789",
      "lastStatusChange": "xyz789",
      "locked": false,
      "machineId": "xyz789",
      "memoryInGb": 987.65,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 43612,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 987,
      "vcpuCount": 123.45,
      "version": 123,
      "volumeEncrypted": false,
      "volumeInGb": 123.45,
      "volumeKey": "xyz789",
      "volumeMountPath": "xyz789",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "abc123",
      "machineType": "xyz789",
      "slsVersion": 123,
      "networkVolumeId": "abc123",
      "testPod": false,
      "ideAiApiId": "abc123",
      "hubReleaseId": "abc123",
      "hubRelease": HubRelease,
      "modelVersions": [ModelVersionPodAssignment],
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan],
      "clusterId": "xyz789",
      "ipAddress": IPAddress,
      "models": ["xyz789"]
    }
  }
}

Mutations

`podRentInterruptable`

Response

Returns a Pod

Arguments

Name	Description
`input` - `PodRentInterruptableInput!`

Example

Query

mutation podRentInterruptable($input: PodRentInterruptableInput!) {
  podRentInterruptable(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    clusterIp
    clusterIdx
    clusterCidr
    clusterRole
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    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
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    testPod
    ideAiApiId
    hubReleaseId
    hubRelease {
      ...HubReleaseFragment
    }
    modelVersions {
      ...ModelVersionPodAssignmentFragment
    }
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
    clusterId
    ipAddress {
      ...IPAddressFragment
    }
    models
  }
}

Variables

{"input": PodRentInterruptableInput}

Response

{
  "data": {
    "podRentInterruptable": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "xyz789",
      "apiKey": "xyz789",
      "clusterIp": "abc123",
      "clusterIdx": 987,
      "clusterCidr": "abc123",
      "clusterRole": "SLURM_CONTROLLER",
      "consumerUserId": "abc123",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "xyz789",
      "env": ["xyz789"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "xyz789",
      "lastStatusChange": "xyz789",
      "locked": true,
      "machineId": "xyz789",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 43612,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 987,
      "vcpuCount": 123.45,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "xyz789",
      "volumeMountPath": "xyz789",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "xyz789",
      "slsVersion": 123,
      "networkVolumeId": "abc123",
      "testPod": false,
      "ideAiApiId": "abc123",
      "hubReleaseId": "xyz789",
      "hubRelease": HubRelease,
      "modelVersions": [ModelVersionPodAssignment],
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan],
      "clusterId": "xyz789",
      "ipAddress": IPAddress,
      "models": ["abc123"]
    }
  }
}

Mutations

`podResume`

Response

Returns a Pod

Arguments

Name	Description
`input` - `PodResumeInput!`

Example

Query

mutation podResume($input: PodResumeInput!) {
  podResume(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    clusterIp
    clusterIdx
    clusterCidr
    clusterRole
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    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
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    testPod
    ideAiApiId
    hubReleaseId
    hubRelease {
      ...HubReleaseFragment
    }
    modelVersions {
      ...ModelVersionPodAssignmentFragment
    }
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
    clusterId
    ipAddress {
      ...IPAddressFragment
    }
    models
  }
}

Variables

{"input": PodResumeInput}

Response

{
  "data": {
    "podResume": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "abc123",
      "apiKey": "abc123",
      "clusterIp": "xyz789",
      "clusterIdx": 123,
      "clusterCidr": "abc123",
      "clusterRole": "SLURM_CONTROLLER",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["abc123"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "abc123",
      "lastStatusChange": "xyz789",
      "locked": true,
      "machineId": "xyz789",
      "memoryInGb": 123.45,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 43612,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 987,
      "vcpuCount": 987.65,
      "version": 987,
      "volumeEncrypted": false,
      "volumeInGb": 123.45,
      "volumeKey": "xyz789",
      "volumeMountPath": "abc123",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "xyz789",
      "slsVersion": 987,
      "networkVolumeId": "xyz789",
      "testPod": false,
      "ideAiApiId": "xyz789",
      "hubReleaseId": "abc123",
      "hubRelease": HubRelease,
      "modelVersions": [ModelVersionPodAssignment],
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan],
      "clusterId": "abc123",
      "ipAddress": IPAddress,
      "models": ["xyz789"]
    }
  }
}

Mutations

`podStop`

Response

Returns a Pod

Arguments

Name	Description
`input` - `PodStopInput!`

Example

Query

mutation podStop($input: PodStopInput!) {
  podStop(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    clusterIp
    clusterIdx
    clusterCidr
    clusterRole
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    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
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    testPod
    ideAiApiId
    hubReleaseId
    hubRelease {
      ...HubReleaseFragment
    }
    modelVersions {
      ...ModelVersionPodAssignmentFragment
    }
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
    clusterId
    ipAddress {
      ...IPAddressFragment
    }
    models
  }
}

Variables

{"input": PodStopInput}

Response

{
  "data": {
    "podStop": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "xyz789",
      "apiKey": "xyz789",
      "clusterIp": "abc123",
      "clusterIdx": 987,
      "clusterCidr": "xyz789",
      "clusterRole": "SLURM_CONTROLLER",
      "consumerUserId": "abc123",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "abc123",
      "costMultiplier": 987.65,
      "costPerHr": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "xyz789",
      "env": ["abc123"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "xyz789",
      "lastStatusChange": "xyz789",
      "locked": true,
      "machineId": "xyz789",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 43612,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 987,
      "vcpuCount": 123.45,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "abc123",
      "volumeMountPath": "abc123",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "xyz789",
      "slsVersion": 987,
      "networkVolumeId": "xyz789",
      "testPod": false,
      "ideAiApiId": "abc123",
      "hubReleaseId": "xyz789",
      "hubRelease": HubRelease,
      "modelVersions": [ModelVersionPodAssignment],
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan],
      "clusterId": "xyz789",
      "ipAddress": IPAddress,
      "models": ["xyz789"]
    }
  }
}

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": "abc123",
      "registryAuth": "xyz789"
    }
  }
}

Types

AdminUserReferrals

Fields

Field Name	Description
`id` - `String`
`email` - `String`
`signUpMethod` - `SignUpMethod`
`createdAt` - `DateTime`
`signedTermsOfService` - `Boolean`
`referralEmailUsage` - `ReferralEmailUsage`
`referralCode` - `String`
`affiliateKey` - `String`
`clientLifetimeSpend` - `Float`
`activatedAt` - `DateTime`
`earnings` - `AffiliateProgramEarnings`
`referredUsers` - `[AdminUserReferrals]`
`referralBonus` - `Float`
`referredById` - `String`
`referredByEmail` - `String`

Example

{
  "id": "abc123",
  "email": "xyz789",
  "signUpMethod": "GOOGLE",
  "createdAt": "2007-12-03T10:15:30Z",
  "signedTermsOfService": false,
  "referralEmailUsage": ReferralEmailUsage,
  "referralCode": "xyz789",
  "affiliateKey": "xyz789",
  "clientLifetimeSpend": 123.45,
  "activatedAt": "2007-12-03T10:15:30Z",
  "earnings": AffiliateProgramEarnings,
  "referredUsers": [AdminUserReferrals],
  "referralBonus": 987.65,
  "referredById": "xyz789",
  "referredByEmail": "xyz789"
}

Types

AffiliateProgramEarnings

Fields

Field Name	Description
`totalReferrals` - `Int`
`totalPaidReferrals` - `Int`
`templateEarnings` - `Float`
`referralEarnings` - `Float`
`referralBonusEarnings` - `Float`
`affiliateEarnings` - `Float`

Example

{
  "totalReferrals": 123,
  "totalPaidReferrals": 123,
  "templateEarnings": 123.45,
  "referralEarnings": 123.45,
  "referralBonusEarnings": 123.45,
  "affiliateEarnings": 987.65
}

Types

ApiKey

Fields

Field Name	Description
`id` - `String`
`permissions` - `String!`
`createdAt` - `DateTime!`
`lastUsed` - `DateTime`
`name` - `String`
`policies` - `JSON`
`isActive` - `Boolean`
`isActiveHumanReadableString` - `String`
`isLegacy` - `Boolean`

Example

{
  "id": "abc123",
  "permissions": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "lastUsed": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "policies": {},
  "isActive": true,
  "isActiveHumanReadableString": "abc123",
  "isLegacy": true
}

Types

AssignmentStatus

Values

Enum Value	Description
`ASSIGNED`
`UNASSIGNED`
`DEPLOYED`
`EVICTED`

Example

"ASSIGNED"

Types

AuditLog

Fields

Field Name	Description
`actorId` - `String`
`email` - `String`
`ownerId` - `String`
`resourceType` - `String`
`resourceId` - `String`
`action` - `String`
`value` - `String`
`timestamp` - `DateTime`

Example

{
  "actorId": "abc123",
  "email": "xyz789",
  "ownerId": "abc123",
  "resourceType": "abc123",
  "resourceId": "abc123",
  "action": "xyz789",
  "value": "xyz789",
  "timestamp": "2007-12-03T10:15:30Z"
}

Types

AuditLogConnection

Fields

Field Name	Description
`edges` - `[AuditLog]`
`pageInfo` - `PageInfo`

Example

{
  "edges": [AuditLog],
  "pageInfo": PageInfo
}

Types

BenchmarkPod

Fields

Field Name	Description
`id` - `String`
`desiredStatus` - `String`

Example

{
  "id": "xyz789",
  "desiredStatus": "xyz789"
}

Types

BillingGranularity

Values

Enum Value	Description
`MINUTELY`
`HOURLY`
`DAILY`
`WEEKLY`
`MONTHLY`

Example

"MINUTELY"

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Card

Fields

Field Name	Description
`brand` - `String`
`last4` - `String`
`expMonth` - `Int`
`expYear` - `Int`

Example

{
  "brand": "abc123",
  "last4": "xyz789",
  "expMonth": 987,
  "expYear": 123
}

Types

ChecklistPath

Fields

Field Name	Description
`pod` - `Boolean`
`serverless` - `Boolean`
`public_endpoint` - `Boolean`
`instant_cluster` - `Boolean`

Example

{
  "pod": true,
  "serverless": false,
  "public_endpoint": true,
  "instant_cluster": true
}

Types

ClientCreditCharge

Fields

Field Name	Description
`amount` - `Float`
`updatedAt` - `DateTime`
`diskCharges` - `Float`
`podCharges` - `Float`
`apiCharges` - `Float`
`serverlessCharges` - `Float`
`type` - `ClientCreditChargeType`

Example

{
  "amount": 123.45,
  "updatedAt": "2007-12-03T10:15:30Z",
  "diskCharges": 987.65,
  "podCharges": 987.65,
  "apiCharges": 123.45,
  "serverlessCharges": 123.45,
  "type": "CHARGE_SERVERLESS"
}

Types

ClientCreditChargeType

Values

Enum Value	Description
`CHARGE_SERVERLESS`
`CHARGE_POD`
`CHARGE_API`
`CHARGE_STORAGE`
`CHARGE_SAVINGS_PLAN`

Example

"CHARGE_SERVERLESS"

Types

CloudStorage

Fields

Field Name	Description
`id` - `ID!`
`provider` - `CloudStorageProvider!`
`region` - `String!`
`bucketName` - `String!`
`status` - `CloudStorageStatus!`
`createdAt` - `String!`
`updatedAt` - `String!`

Example

{
  "id": 4,
  "provider": "AWS",
  "region": "xyz789",
  "bucketName": "xyz789",
  "status": "ACTIVE",
  "createdAt": "xyz789",
  "updatedAt": "abc123"
}

Types

CloudStorageProvider

Values

Enum Value	Description
`AWS`
`CF`

Example

"AWS"

Types

CloudStorageStatus

Values

Enum Value	Description
`ACTIVE`
`INACTIVE`

Example

"ACTIVE"

Types

CloudTypeEnum

Values

Enum Value	Description
`SECURE`
`COMMUNITY`
`ALL`

Example

"SECURE"

Types

Cluster

Fields

Field Name	Description
`id` - `String`
`name` - `String`
`userId` - `String`
`gpuTypeId` - `String`
`gpuDisplayName` - `String`
`podCount` - `Int`
`gpuCountPerPod` - `Int`
`type` - `ClusterType`
`templateId` - `String`
`createdAt` - `DateTime`
`pods` - `[Pod]`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "userId": "xyz789",
  "gpuTypeId": "abc123",
  "gpuDisplayName": "xyz789",
  "podCount": 123,
  "gpuCountPerPod": 987,
  "type": "APPLICATION",
  "templateId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "pods": [Pod]
}

Types

ClusterInput

Fields

Input Field	Description
`id` - `String!`

Example

{"id": "abc123"}

Types

ClusterRole

Values

Enum Value	Description
`SLURM_CONTROLLER`
`SLURM_COMPUTE`

Example

"SLURM_CONTROLLER"

Types

ClusterType

Values

Enum Value	Description
`APPLICATION`
`TRAINING`
`SLURM`

Example

"APPLICATION"

Types

Compliance

Values

Enum Value	Description
`GDPR`
`ISO_IEC_27001`
`ISO_14001`
`PCI_DSS`
`HITRUST`
`SOC_1_TYPE_2`
`SOC_2_TYPE_2`
`SOC_3_TYPE_2`
`ITAR`
`FISMA_HIGH`

Example

"GDPR"

Types

ComputeType

Values

Enum Value	Description
`CPU`
`GPU`

Example

"CPU"

Types

ContainerRegistryAuth

Fields

Field Name	Description
`id` - `String`
`name` - `String`
`userId` - `String`
`registryAuth` - `String`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "userId": "xyz789",
  "registryAuth": "xyz789"
}

Types

CpuFlavor

Fields

Field Name	Description
`id` - `String`
`groupId` - `String`
`groupName` - `String`
`displayName` - `String`
`minVcpu` - `Float`
`maxVcpu` - `Int`
`vcpuBurstable` - `Boolean`
`ramMultiplier` - `Float`
`diskLimitPerVcpu` - `Int`
`specifics` - `Specifics`
Arguments `input` - `SpecificsInput`

Example

{
  "id": "xyz789",
  "groupId": "abc123",
  "groupName": "abc123",
  "displayName": "abc123",
  "minVcpu": 123.45,
  "maxVcpu": 987,
  "vcpuBurstable": true,
  "ramMultiplier": 123.45,
  "diskLimitPerVcpu": 987,
  "specifics": Specifics
}

Types

CpuType

Fields

Field Name	Description
`id` - `String`
`displayName` - `String`
`manufacturer` - `String`
`cores` - `Int`
`threadsPerCore` - `Int`
`groupId` - `String`

Example

{
  "id": "abc123",
  "displayName": "abc123",
  "manufacturer": "abc123",
  "cores": 987,
  "threadsPerCore": 987,
  "groupId": "abc123"
}

Types

CreateClusterInput

Fields

Input Field	Description
`clusterName` - `String`
`gpuTypeId` - `String!`
`podCount` - `Int!`
`gpuCountPerPod` - `Int!`
`type` - `ClusterType!`
`templateId` - `String`
`deployCost` - `Float`
`networkVolumeId` - `String`
`volumeInGb` - `Int`
`throughput` - `Int`
`allowedCudaVersions` - `[String]`
`minCudaVersion` - `String`
`volumeKey` - `String`
`dataCenterId` - `String`
`startJupyter` - `Boolean`
`startSsh` - `Boolean`
`containerDiskInGb` - `Int`
`imageName` - `String`
`dockerArgs` - `String`
`env` - `[EnvironmentVariableInput]`
`volumeMountPath` - `String`
`ports` - `String`

Example

{
  "clusterName": "xyz789",
  "gpuTypeId": "xyz789",
  "podCount": 987,
  "gpuCountPerPod": 987,
  "type": "APPLICATION",
  "templateId": "xyz789",
  "deployCost": 987.65,
  "networkVolumeId": "xyz789",
  "volumeInGb": 123,
  "throughput": 987,
  "allowedCudaVersions": ["xyz789"],
  "minCudaVersion": "xyz789",
  "volumeKey": "xyz789",
  "dataCenterId": "abc123",
  "startJupyter": false,
  "startSsh": true,
  "containerDiskInGb": 123,
  "imageName": "abc123",
  "dockerArgs": "xyz789",
  "env": [EnvironmentVariableInput],
  "volumeMountPath": "xyz789",
  "ports": "xyz789"
}

Types

CreditCode

Fields

Field Name	Description
`id` - `String`
`issuerId` - `String`
`createdAt` - `DateTime`
`redeemedAt` - `DateTime`
`amount` - `Int`

Example

{
  "id": "xyz789",
  "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`
`s3apiEnabled` - `Boolean`
`globalNetwork` - `Boolean`
`storageClusters` - `[StorageClusterInfo]`
`storageSupport` - `Boolean`
`listed` - `Boolean`
`gpuAvailability` - `[GpuAvailability]`
Arguments `input` - `GpuAvailabilityInput`
`compliance` - `[Compliance]`
`region` - `DataCenterRegion`
`pools` - `[Pool!]!`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "location": "abc123",
  "storage": DataCenterStorage,
  "s3apiEnabled": true,
  "globalNetwork": true,
  "storageClusters": [StorageClusterInfo],
  "storageSupport": true,
  "listed": true,
  "gpuAvailability": [GpuAvailability],
  "compliance": ["GDPR"],
  "region": "NORTH_AMERICA",
  "pools": [Pool]
}

Types

DataCenterRegion

Values

Enum Value	Description
`NORTH_AMERICA`
`ASIA`
`EUROPE`
`MIDDLE_EAST`
`AFRICA`
`SOUTH_AMERICA`
`OCEANIA`
`ANTARCTICA`
`UNKNOWN`

Example

"NORTH_AMERICA"

Types

DataCenterStorage

Fields

Field Name	Description
`hostname` - `String`
`ips` - `[String]`
`pw` - `String`
`type` - `String`
`user` - `String`
`list` - `[DataCenterStorageList]`

Example

{
  "hostname": "abc123",
  "ips": ["xyz789"],
  "pw": "xyz789",
  "type": "abc123",
  "user": "abc123",
  "list": [DataCenterStorageList]
}

Types

DataCenterStorageList

Fields

Field Name	Description
`mnt` - `String`
`pw` - `String`
`servers` - `[String]`
`type` - `String`
`versions` - `[Int]`
`primary` - `Boolean`

Example

{
  "mnt": "xyz789",
  "pw": "abc123",
  "servers": ["xyz789"],
  "type": "abc123",
  "versions": [123],
  "primary": true
}

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

DeleteClusterInput

Fields

Input Field	Description
`id` - `String!`

Example

{"id": "abc123"}

Types

DiscordAccountInfo

Fields

Field Name	Description
`discordId` - `String`
`username` - `String`

Example

{
  "discordId": "xyz789",
  "username": "abc123"
}

Types

Discount

Fields

Field Name	Description
`userId` - `String!`
`type` - `DiscountType!`
`discountFactor` - `Float!`
`expirationDate` - `DateTime!`
`activeDiscountFactor` - `Float`
`activeWorkers` - `Int`

Example

{
  "userId": "abc123",
  "type": "SERVERLESS",
  "discountFactor": 123.45,
  "expirationDate": "2007-12-03T10:15:30Z",
  "activeDiscountFactor": 123.45,
  "activeWorkers": 123
}

Types

DiscountType

Values

Enum Value	Description
`SERVERLESS`
`SERVERLESS_LO_VRAM`
`SERVERLESS_HI_VRAM`

Example

"SERVERLESS"

Types

EarningsCustomRangeInput

Fields

Input Field	Description
`startDate` - `Date!`
`endDate` - `Date!`

Example

{
  "startDate": "2007-12-03",
  "endDate": "2007-12-03"
}

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`
`workersPFBTarget` - `Int`
`gpuCount` - `Int`
`env` - `[EnvironmentVariable]`
`createdAt` - `DateTime`
`allowedCudaVersions` - `String`
`minCudaVersion` - `String`
`executionTimeoutMs` - `Int`
`instanceIds` - `[String]`
`computeType` - `ComputeType`
`builds` - `[GitBuild]`
`activeBuildid` - `String`
`repo` - `Repo`
`hubRelease` - `HubRelease`
`idePodId` - `String`
`modelStatus` - `ModelStatus`
`modelReferences` - `[String]`
`workerState` - `[WorkerState]`
Arguments `input` - `WorkerStateInput!`
`webhookRequests` - `[WebhookRequestStatus]`
Arguments `input` - `WebhookRequestsInput!`
`networkVolume` - `NetworkVolume`

Example

{
  "aiKey": "abc123",
  "gpuIds": "abc123",
  "id": "abc123",
  "idleTimeout": 987,
  "name": "abc123",
  "networkVolumeId": "abc123",
  "locations": "xyz789",
  "pods": [Pod],
  "scalerType": "xyz789",
  "scalerValue": 123,
  "template": PodTemplate,
  "templateId": "xyz789",
  "type": "abc123",
  "userId": "xyz789",
  "version": 123,
  "workersMax": 987,
  "workersMin": 987,
  "workersStandby": 123,
  "workersPFBTarget": 987,
  "gpuCount": 123,
  "env": [EnvironmentVariable],
  "createdAt": "2007-12-03T10:15:30Z",
  "allowedCudaVersions": "abc123",
  "minCudaVersion": "xyz789",
  "executionTimeoutMs": 123,
  "instanceIds": ["xyz789"],
  "computeType": "CPU",
  "builds": [GitBuild],
  "activeBuildid": "abc123",
  "repo": Repo,
  "hubRelease": HubRelease,
  "idePodId": "abc123",
  "modelStatus": "ACTIVE",
  "modelReferences": ["xyz789"],
  "workerState": [WorkerState],
  "webhookRequests": [WebhookRequestStatus],
  "networkVolume": NetworkVolume
}

Types

EndpointStatisticGranularity

Values

Enum Value	Description
`LIVE`
`HOURLY`
`DAILY`
`WEEKLY`
`MONTHLY`

Example

"LIVE"

Types

EnvironmentVariable

Fields

Field Name	Description
`key` - `String`
`value` - `String`

Example

{
  "key": "xyz789",
  "value": "xyz789"
}

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

GitBuild

Fields

Field Name	Description
`id` - `String!`
`commitHash` - `String`
`commitMessage` - `String`
`branch` - `String`
`commitDate` - `DateTime`
`state` - `GitBuildState`
`startedAt` - `DateTime`
`completedAt` - `DateTime`
`error` - `String`
`repoId` - `String`
`imageName` - `String`
`test` - `Test`

Example

{
  "id": "abc123",
  "commitHash": "xyz789",
  "commitMessage": "abc123",
  "branch": "abc123",
  "commitDate": "2007-12-03T10:15:30Z",
  "state": "PENDING",
  "startedAt": "2007-12-03T10:15:30Z",
  "completedAt": "2007-12-03T10:15:30Z",
  "error": "abc123",
  "repoId": "xyz789",
  "imageName": "xyz789",
  "test": Test
}

Types

GitBuildState

Values

Enum Value	Description
`PENDING`
`BUILDING`
`UPLOADING`
`COMPLETED`
`FAILED`
`CANCELLED`
`TESTING`
`TEST_FAILED`

Example

"PENDING"

Types

GithubAccountInfo

Fields

Field Name	Description
`githubId` - `String`
`avatarUrl` - `String`
`username` - `String`

Example

{
  "githubId": "xyz789",
  "avatarUrl": "abc123",
  "username": "xyz789"
}

Types

Gpu

Fields

Field Name	Description
`id` - `String!`
`podId` - `String`

Example

{
  "id": "xyz789",
  "podId": "xyz789"
}

Types

GpuAvailability

Fields

Field Name	Description
`available` - `Boolean`
`stockStatus` - `String`
`gpuTypeId` - `String`
`gpuType` - `GpuType`
`gpuTypeDisplayName` - `String`
`displayName` - `String`
`id` - `String`

Example

{
  "available": false,
  "stockStatus": "xyz789",
  "gpuTypeId": "xyz789",
  "gpuType": GpuType,
  "gpuTypeDisplayName": "abc123",
  "displayName": "xyz789",
  "id": "abc123"
}

Types

GpuAvailabilityInput

Fields

Input Field	Description
`gpuCount` - `Int`
`minDisk` - `Int`
`minMemoryInGb` - `Int`
`minVcpuCount` - `Int`
`secureCloud` - `Boolean`
`allowedCudaVersions` - `[String]`
`minCudaVersion` - `String`
`includeAiApi` - `Boolean`

Example

{
  "gpuCount": 123,
  "minDisk": 123,
  "minMemoryInGb": 123,
  "minVcpuCount": 987,
  "secureCloud": false,
  "allowedCudaVersions": ["xyz789"],
  "minCudaVersion": "xyz789",
  "includeAiApi": false
}

Types

GpuLowestPriceInput

Fields

Input Field	Description
`countryCode` - `String`
`dataCenterId` - `String`	data center ids concatenated by comma (e.g. 'AMD-1,CA-MTL-1')
`gpuCount` - `Int!`
`includeAiApi` - `Boolean`
`minDisk` - `Int`
`minDownload` - `Int`
`minMemoryInGb` - `Int`
`minUpload` - `Int`
`minVcpuCount` - `Int`
`secureCloud` - `Boolean`
`supportPublicIp` - `Boolean`
`totalDisk` - `Int`
`cudaVersion` - `String`
`allowedCudaVersions` - `[String]`
`minCudaVersion` - `String`
`compliance` - `[Compliance]`
`isCluster` - `Boolean`
`podCount` - `Int`
`throughput` - `Int`
`globalNetwork` - `Boolean`

Example

{
  "countryCode": "xyz789",
  "dataCenterId": "xyz789",
  "gpuCount": 123,
  "includeAiApi": false,
  "minDisk": 987,
  "minDownload": 123,
  "minMemoryInGb": 987,
  "minUpload": 987,
  "minVcpuCount": 123,
  "secureCloud": false,
  "supportPublicIp": false,
  "totalDisk": 987,
  "cudaVersion": "xyz789",
  "allowedCudaVersions": ["xyz789"],
  "minCudaVersion": "abc123",
  "compliance": ["GDPR"],
  "isCluster": false,
  "podCount": 987,
  "throughput": 123,
  "globalNetwork": true
}

Types

GpuTelemetry

Fields

Field Name	Description
`id` - `String`
`percentUtilization` - `Float`
`temperatureCelcius` - `Float`
`memoryUtilization` - `Float`
`powerWatts` - `Float`

Example

{
  "id": "abc123",
  "percentUtilization": 987.65,
  "temperatureCelcius": 987.65,
  "memoryUtilization": 987.65,
  "powerWatts": 987.65
}

Types

GpuType

Fields

Field Name	Description
`lowestPrice` - `LowestPrice`
Arguments `input` - `GpuLowestPriceInput`
`maxGpuCount` - `Int`
`maxGpuCountCommunityCloud` - `Int`
`maxGpuCountSecureCloud` - `Int`
`minPodGpuCount` - `Int`
`nodeGroupGpuSizes` - `[Int]`
`nodeGroupDatacenters` - `[DataCenter]`
`id` - `String`
`displayName` - `String`
`manufacturer` - `String`
`memoryInGb` - `Int`
`cudaCores` - `Int`
`secureCloud` - `Boolean`
`communityCloud` - `Boolean`
`securePrice` - `Float`
`clusterPrice` - `Float`
`communityPrice` - `Float`
`oneMonthPrice` - `Float`
`threeMonthPrice` - `Float`
`sixMonthPrice` - `Float`
`oneYearPrice` - `Float`
`oneWeekPrice` - `Float`
`communitySpotPrice` - `Float`
`secureSpotPrice` - `Float`
`throughput` - `Int`

Example

{
  "lowestPrice": LowestPrice,
  "maxGpuCount": 123,
  "maxGpuCountCommunityCloud": 987,
  "maxGpuCountSecureCloud": 987,
  "minPodGpuCount": 987,
  "nodeGroupGpuSizes": [123],
  "nodeGroupDatacenters": [DataCenter],
  "id": "abc123",
  "displayName": "xyz789",
  "manufacturer": "xyz789",
  "memoryInGb": 987,
  "cudaCores": 987,
  "secureCloud": false,
  "communityCloud": false,
  "securePrice": 123.45,
  "clusterPrice": 987.65,
  "communityPrice": 987.65,
  "oneMonthPrice": 987.65,
  "threeMonthPrice": 987.65,
  "sixMonthPrice": 987.65,
  "oneYearPrice": 123.45,
  "oneWeekPrice": 123.45,
  "communitySpotPrice": 123.45,
  "secureSpotPrice": 123.45,
  "throughput": 123
}

Types

GpuTypeFilter

Fields

Input Field	Description
`id` - `String`
`ids` - `[String!]`
`cluster` - `Boolean`

Example

{
  "id": "xyz789",
  "ids": ["xyz789"],
  "cluster": false
}

Types

HubRelease

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`tagName` - `String!`
`createdAt` - `DateTime!`
`releasedAt` - `DateTime!`
`updatedAt` - `DateTime!`
`authorName` - `String`
`authorId` - `String`
`authorAvatarUrl` - `String`
`iconUrl` - `String`
`body` - `String`
`readme` - `String`
`branch` - `String`
`license` - `String`
`deploys` - `Int!`
`config` - `String`
`build` - `GitBuild`
`listing` - `Listing`

Example

{
  "id": "4",
  "name": "xyz789",
  "tagName": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "releasedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "authorName": "abc123",
  "authorId": "abc123",
  "authorAvatarUrl": "xyz789",
  "iconUrl": "xyz789",
  "body": "xyz789",
  "readme": "abc123",
  "branch": "abc123",
  "license": "xyz789",
  "deploys": 987,
  "config": "abc123",
  "build": GitBuild,
  "listing": Listing
}

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

"4"

Types

IPAddress

Fields

Field Name	Description
`id` - `String`
`address` - `String`
`networkRangeId` - `String`
`networkRange` - `NetworkRange`
`pod` - `Pod`
`podnetNodes` - `[PodnetNode]`

Example

{
  "id": "abc123",
  "address": "abc123",
  "networkRangeId": "abc123",
  "networkRange": NetworkRange,
  "pod": Pod,
  "podnetNodes": [PodnetNode]
}

Types

Impersonation

Fields

Field Name	Description
`auditLogs` - `AuditLogConnection`
`id` - `ID!`
`zendeskTicketId` - `ID!`
`impersonateUserId` - `String!`
`createdAt` - `DateTime!`
`expiresAt` - `DateTime!`
`accepted` - `Boolean!`
`acceptedAt` - `DateTime`

Example

{
  "auditLogs": AuditLogConnection,
  "id": "4",
  "zendeskTicketId": 4,
  "impersonateUserId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z",
  "accepted": false,
  "acceptedAt": "2007-12-03T10:15:30Z"
}

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

Types

JSON

Description

The JSON scalar type represents JSON values as specified by ECMA-404.

Example

{}

Types

Listing

Fields

Field Name	Description
`id` - `ID!`
`listed` - `Boolean!`
`repoId` - `String!`
`title` - `String`
`description` - `String`
`repoName` - `String!`
`repoOwner` - `String!`
`repoOwnerAvatarUrl` - `String`
`createdAt` - `DateTime!`
`updatedAt` - `DateTime!`
`lastScannedAt` - `DateTime`
`views` - `Int!`
`stars` - `Int!`
`deploys` - `Int!`
`openIssues` - `Int!`
`watchers` - `Int!`
`language` - `String`
`tags` - `[String!]!`
`category` - `String`
`type` - `String!`
`rejectNote` - `String`
`releases` - `[HubRelease]!`
`listedRelease` - `HubRelease`

Example

{
  "id": 4,
  "listed": false,
  "repoId": "abc123",
  "title": "xyz789",
  "description": "abc123",
  "repoName": "abc123",
  "repoOwner": "abc123",
  "repoOwnerAvatarUrl": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "lastScannedAt": "2007-12-03T10:15:30Z",
  "views": 987,
  "stars": 123,
  "deploys": 123,
  "openIssues": 987,
  "watchers": 987,
  "language": "abc123",
  "tags": ["xyz789"],
  "category": "xyz789",
  "type": "abc123",
  "rejectNote": "abc123",
  "releases": [HubRelease],
  "listedRelease": HubRelease
}

Types

LowestPrice

Fields

Field Name	Description
`gpuName` - `String`
`gpuTypeId` - `String`
`minimumBidPrice` - `Float`
`uninterruptablePrice` - `Float`
`clusterPrice` - `Float`
`minMemory` - `Int`
`minVcpu` - `Int`
`rentalPercentage` - `Float`
`rentedCount` - `Int`
`totalCount` - `Int`
`stockStatus` - `String`
`minDownload` - `Int`
`minDisk` - `Int`
`minUpload` - `Int`
`countryCode` - `String`
`supportPublicIp` - `Boolean`
`compliance` - `[Compliance]`
`maxGpuCount` - `Int`
`maxUnreservedGpuCount` - `Int`
`availableGpuCounts` - `[Int]`

Example

{
  "gpuName": "abc123",
  "gpuTypeId": "abc123",
  "minimumBidPrice": 987.65,
  "uninterruptablePrice": 123.45,
  "clusterPrice": 987.65,
  "minMemory": 123,
  "minVcpu": 987,
  "rentalPercentage": 123.45,
  "rentedCount": 987,
  "totalCount": 987,
  "stockStatus": "abc123",
  "minDownload": 123,
  "minDisk": 987,
  "minUpload": 987,
  "countryCode": "abc123",
  "supportPublicIp": true,
  "compliance": ["GDPR"],
  "maxGpuCount": 987,
  "maxUnreservedGpuCount": 987,
  "availableGpuCounts": [987]
}

Types

Machine

Fields

Field Name	Description
`pods` - `[Pod]`
`id` - `String`
`userId` - `String`
`name` - `String`
`registered` - `Boolean`
`podCloudEnabled` - `Boolean`
`clusterEnabled` - `Boolean`
`slsEnabled` - `Boolean`
`priority` - `Int`
`minPodGpuCount` - `Int`
`gpuTypeId` - `String`
`gpuType` - `GpuType`
`gpuPowerLimitPercentageRented` - `Int`
`gpuPowerLimitPercentageSelf` - `Int`
`cpuCount` - `Int`
`cpuTypeId` - `String`
`cpuType` - `CpuType`
`dataCenter` - `DataCenter`
`moboName` - `String`
`hidden` - `Boolean`
`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`
`totalGpuAllocated` - `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`
`maintenanceMode` - `Boolean`
`note` - `String`
`machineBalance` - `MachineBalance`
`machineSystem` - `MachineSystem`
`dataCenterId` - `String`
`machineType` - `String`
`lastBenchmark` - `MachineBenchmark`
`upcomingMaintenances` - `[MachineMaintenance]`
`nextMaintenance` - `MachineMaintenance`
`nodeGroupId` - `String`
`lastSyncAt` - `DateTime`
`markedForDeletion` - `Boolean`
`pinCpus` - `Boolean`
`modelRepos` - `[ModelRepo]`
`poolState` - `MachinePoolState`
`poolId` - `String`
`backgroundPodTelemetry` - `PodTelemetry`
Arguments `input` - `backgroundPodTelemetryInput`
`latestTelemetry` - `MachineTelemetry`
`uptime` - `MachineUptime`
`runpodIp` - `String`
`publicIp` - `String`

Example

{
  "pods": [Pod],
  "id": "xyz789",
  "userId": "xyz789",
  "name": "abc123",
  "registered": false,
  "podCloudEnabled": true,
  "clusterEnabled": false,
  "slsEnabled": false,
  "priority": 123,
  "minPodGpuCount": 123,
  "gpuTypeId": "xyz789",
  "gpuType": GpuType,
  "gpuPowerLimitPercentageRented": 123,
  "gpuPowerLimitPercentageSelf": 123,
  "cpuCount": 123,
  "cpuTypeId": "xyz789",
  "cpuType": CpuType,
  "dataCenter": DataCenter,
  "moboName": "xyz789",
  "hidden": false,
  "hostPricePerGpu": 987.65,
  "hostMinBidPerGpu": 987.65,
  "defaultImageName": "xyz789",
  "defaultStartScript": "xyz789",
  "defaultArguments": "abc123",
  "defaultDiskInGb": 987,
  "defaultPort": 43612,
  "defaultEnv": ["abc123"],
  "location": "xyz789",
  "listed": true,
  "verified": false,
  "machineId": "abc123",
  "diskReserved": 123,
  "diskTotal": 987,
  "diskMBps": 123,
  "downloadMbps": 123,
  "gpuReserved": 987,
  "totalGpuAllocated": 987,
  "gpuTotal": 123,
  "pcieLink": 123,
  "pcieLinkWidth": 987,
  "memoryReserved": 123,
  "memoryTotal": 987,
  "uploadMbps": 123,
  "vcpuReserved": 123,
  "vcpuTotal": 987,
  "installCert": "xyz789",
  "uptimePercentListedOneWeek": 987.65,
  "uptimePercentListedFourWeek": 987.65,
  "uptimePercentListedTwelveWeek": 123.45,
  "uptimePercentAbsoluteTwelveWeek": 123.45,
  "margin": 987.65,
  "gpuCloudPrice": 123.45,
  "supportPublicIp": true,
  "secureCloud": false,
  "ownedByMe": false,
  "idleJobTemplateId": "xyz789",
  "idleJobTemplate": PodTemplate,
  "maintenanceStart": "2007-12-03T10:15:30Z",
  "maintenanceEnd": "2007-12-03T10:15:30Z",
  "maintenanceNote": "abc123",
  "maintenanceMode": true,
  "note": "abc123",
  "machineBalance": MachineBalance,
  "machineSystem": MachineSystem,
  "dataCenterId": "xyz789",
  "machineType": "xyz789",
  "lastBenchmark": MachineBenchmark,
  "upcomingMaintenances": [MachineMaintenance],
  "nextMaintenance": MachineMaintenance,
  "nodeGroupId": "xyz789",
  "lastSyncAt": "2007-12-03T10:15:30Z",
  "markedForDeletion": true,
  "pinCpus": true,
  "modelRepos": [ModelRepo],
  "poolState": "GENERALLY_AVAILABLE",
  "poolId": "xyz789",
  "backgroundPodTelemetry": PodTelemetry,
  "latestTelemetry": MachineTelemetry,
  "uptime": MachineUptime,
  "runpodIp": "xyz789",
  "publicIp": "abc123"
}

Types

MachineBalance

Fields

Field Name	Description
`hostDiskEarnings` - `Float`
`hostGpuEarnings` - `Float`
`hostTotalEarnings` - `Float`

Example

{
  "hostDiskEarnings": 987.65,
  "hostGpuEarnings": 123.45,
  "hostTotalEarnings": 987.65
}

Types

MachineBenchmark

Fields

Field Name	Description
`errors` - `String`
`benchmarkedAt` - `DateTime`
`gpuCount` - `Int`
`pod` - `BenchmarkPod`

Example

{
  "errors": "xyz789",
  "benchmarkedAt": "2007-12-03T10:15:30Z",
  "gpuCount": 987,
  "pod": BenchmarkPod
}

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": "xyz789",
  "hostTotalEarnings": 123.45,
  "hostGpuEarnings": 123.45,
  "hostDiskEarnings": 123.45
}

Types

MachineMaintenance

Fields

Field Name	Description
`id` - `String`
`machineId` - `String`
`maintenanceStart` - `DateTime`
`maintenanceEnd` - `DateTime`
`maintenanceNote` - `String`

Example

{
  "id": "xyz789",
  "machineId": "xyz789",
  "maintenanceStart": "2007-12-03T10:15:30Z",
  "maintenanceEnd": "2007-12-03T10:15:30Z",
  "maintenanceNote": "abc123"
}

Types

MachinePoolState

Values

Enum Value	Description
`GENERALLY_AVAILABLE`
`POOL_ASSIGNED`
`POOL_AVAILABLE`

Example

"GENERALLY_AVAILABLE"

Types

MachineSummary

Fields

Field Name	Description
`cpuTypeId` - `String`
`diskProfitPerHr` - `Float`
`displayName` - `String`
`gpuTotal` - `Int`
`gpuTypeId` - `String`
`id` - `String`
`listed` - `Int`
`machineType` - `String`
`onDemandPods` - `Int`
`podProfitPerHr` - `Float`
`spotPods` - `Int`
`gpuRented` - `Int`
`cpuRented` - `Int`
`vcpuTotal` - `Int`

Example

{
  "cpuTypeId": "xyz789",
  "diskProfitPerHr": 987.65,
  "displayName": "xyz789",
  "gpuTotal": 987,
  "gpuTypeId": "xyz789",
  "id": "abc123",
  "listed": 987,
  "machineType": "abc123",
  "onDemandPods": 123,
  "podProfitPerHr": 123.45,
  "spotPods": 123,
  "gpuRented": 123,
  "cpuRented": 987,
  "vcpuTotal": 123
}

Types

MachineSystem

Fields

Field Name	Description
`os` - `String`
`cudaVersion` - `String`
`diskTotal` - `Int`
`diskFree` - `Int`
`privateIp` - `String`
`dockerVersion` - `String`
`kernelVersion` - `String`
`publicIp` - `String`

Example

{
  "os": "xyz789",
  "cudaVersion": "abc123",
  "diskTotal": 987,
  "diskFree": 123,
  "privateIp": "xyz789",
  "dockerVersion": "xyz789",
  "kernelVersion": "xyz789",
  "publicIp": "abc123"
}

Types

MachineTelemetry

Fields

Field Name	Description
`time` - `DateTime`
`cpuUtilization` - `Float`
`memoryUtilization` - `Float`
`averageGpuMetrics` - `GpuTelemetry`
`individualGpuMetrics` - `[GpuTelemetry]`

Example

{
  "time": "2007-12-03T10:15:30Z",
  "cpuUtilization": 123.45,
  "memoryUtilization": 123.45,
  "averageGpuMetrics": GpuTelemetry,
  "individualGpuMetrics": [GpuTelemetry]
}

Types

MachineUptime

Fields

Field Name	Description
`error` - `String`
`lastSyncTimestamp` - `Int`
`seconds` - `Int`
`sysUptimeSeconds` - `Int`

Example

{
  "error": "abc123",
  "lastSyncTimestamp": 123,
  "seconds": 123,
  "sysUptimeSeconds": 123
}

Types

Model

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`provider` - `String!`
`owner` - `String!`
`status` - `ModelStatus!`
`createdAt` - `String!`
`updatedAt` - `String!`
`versions` - `[ModelVersion!]`

Example

{
  "id": "4",
  "name": "abc123",
  "provider": "xyz789",
  "owner": "xyz789",
  "status": "ACTIVE",
  "createdAt": "abc123",
  "updatedAt": "xyz789",
  "versions": [ModelVersion]
}

Types

ModelCloudStorageAssignment

Fields

Field Name	Description
`id` - `ID!`
`modelVersionHash` - `ID!`
`cloudStorageId` - `ID!`
`status` - `AssignmentStatus!`
`createdAt` - `String!`
`updatedAt` - `String!`
`modelVersion` - `ModelVersion!`
`cloudStorage` - `CloudStorage!`

Example

{
  "id": "4",
  "modelVersionHash": 4,
  "cloudStorageId": 4,
  "status": "ASSIGNED",
  "createdAt": "abc123",
  "updatedAt": "xyz789",
  "modelVersion": ModelVersion,
  "cloudStorage": CloudStorage
}

Types

ModelMachineAssignment

Fields

Field Name	Description
`id` - `ID!`
`modelVersionHash` - `ID!`
`machineId` - `ID!`
`status` - `AssignmentStatus!`
`createdAt` - `String!`
`updatedAt` - `String!`
`modelVersion` - `ModelVersion!`

Example

{
  "id": 4,
  "modelVersionHash": 4,
  "machineId": 4,
  "status": "ASSIGNED",
  "createdAt": "xyz789",
  "updatedAt": "xyz789",
  "modelVersion": ModelVersion
}

Types

ModelNetworkVolumeAssignment

Fields

Field Name	Description
`id` - `ID!`
`modelVersionHash` - `ID!`
`networkVolumeId` - `ID!`
`status` - `AssignmentStatus!`
`createdAt` - `String!`
`updatedAt` - `String!`
`modelVersion` - `ModelVersion!`

Example

{
  "id": 4,
  "modelVersionHash": 4,
  "networkVolumeId": "4",
  "status": "ASSIGNED",
  "createdAt": "xyz789",
  "updatedAt": "abc123",
  "modelVersion": ModelVersion
}

Types

ModelRepo

Fields

Field Name	Description
`versionHash` - `String`
`files` - `[ModelRepoFile]`
`destPath` - `String`

Example

{
  "versionHash": "xyz789",
  "files": [ModelRepoFile],
  "destPath": "abc123"
}

Types

ModelRepoFile

Fields

Field Name	Description
`blobHash` - `String!`
`path` - `String!`
`size` - `String!`
`url` - `String!`

Example

{
  "blobHash": "abc123",
  "path": "xyz789",
  "size": "xyz789",
  "url": "abc123"
}

Types

ModelStatus

Values

Enum Value	Description
`ACTIVE`
`DISABLED`
`DEPRECATED`

Example

"ACTIVE"

Types

ModelVersion

Fields

Field Name	Description
`hash` - `ID!`
`modelId` - `ID!`
`model` - `Model!`
`metadata` - `JSON`
`status` - `ModelVersionStatus!`
`preAssignmentValue` - `Int`
`createdAt` - `String!`
`updatedAt` - `String!`
`files` - `[ModelVersionFile!]`
`cloudStorageAssignments` - `[ModelCloudStorageAssignment!]`
`machineAssignments` - `[ModelMachineAssignment!]`
`networkVolumeAssignments` - `[ModelNetworkVolumeAssignment!]`

Example

{
  "hash": 4,
  "modelId": "4",
  "model": Model,
  "metadata": {},
  "status": "ACTIVE",
  "preAssignmentValue": 123,
  "createdAt": "xyz789",
  "updatedAt": "xyz789",
  "files": [ModelVersionFile],
  "cloudStorageAssignments": [
    ModelCloudStorageAssignment
  ],
  "machineAssignments": [ModelMachineAssignment],
  "networkVolumeAssignments": [
    ModelNetworkVolumeAssignment
  ]
}

Types

ModelVersionFile

Fields

Field Name	Description
`modelVersionHash` - `ID!`
`filePath` - `String!`
`blobHash` - `String!`
`mode` - `String!`
`size` - `String!`
`createdAt` - `String!`

Example

{
  "modelVersionHash": "4",
  "filePath": "xyz789",
  "blobHash": "xyz789",
  "mode": "abc123",
  "size": "xyz789",
  "createdAt": "xyz789"
}

Types

ModelVersionPodAssignment

Fields

Field Name	Description
`modelVersionHash` - `String!`
`modelVersionUuid` - `String`

Example

{
  "modelVersionHash": "xyz789",
  "modelVersionUuid": "xyz789"
}

Types

ModelVersionStatus

Values

Enum Value	Description
`ACTIVE`
`INACTIVE`
`DEPRECATED`
`PENDING_TRANSFER`
`TRANSFERRING`
`VALIDATING`
`READY`
`FAILED`

Example

"ACTIVE"

Types

NetworkRange

Fields

Field Name	Description
`id` - `String`
`cidr` - `String`
`podnetClusterId` - `String`
`podnetCluster` - `PodnetCluster`
`addresses` - `[IPAddress]`

Example

{
  "id": "xyz789",
  "cidr": "abc123",
  "podnetClusterId": "abc123",
  "podnetCluster": PodnetCluster,
  "addresses": [IPAddress]
}

Types

NetworkStorageEarning

Fields

Field Name	Description
`date` - `DateTime`
`dailyNetworkVolumeEarn` - `Float`
`dataCenterId` - `String`
`runpodEarnings` - `Float`

Example

{
  "date": "2007-12-03T10:15:30Z",
  "dailyNetworkVolumeEarn": 123.45,
  "dataCenterId": "xyz789",
  "runpodEarnings": 123.45
}

Types

NetworkStorageEarningInput

Fields

Input Field	Description
`granularity` - `String`

Example

{"granularity": "xyz789"}

Types

NetworkVolume

Fields

Field Name	Description
`id` - `String`
`name` - `String`
`size` - `Int`
`dataCenterId` - `String`
`dataCenter` - `DataCenter`
`storageClusterId` - `String`
`storageType` - `StorageType`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "size": 123,
  "dataCenterId": "xyz789",
  "dataCenter": DataCenter,
  "storageClusterId": "abc123",
  "storageType": "MOOSE_FS"
}

Types

NodeGroup

Fields

Field Name	Description
`id` - `String`
`name` - `String`
`throughput` - `Int`	Thoughput of network in GigaBytes
`createdAt` - `String`
`listed` - `Boolean`
`infiniband` - `Boolean`
`user` - `User`
`Machines` - `[Machine]`

Example

{
  "id": "abc123",
  "name": "xyz789",
  "throughput": 123,
  "createdAt": "xyz789",
  "listed": true,
  "infiniband": false,
  "user": User,
  "Machines": [Machine]
}

Types

OnboardingInfo

Fields

Field Name	Description
`userId` - `String`
`formStarted` - `DateTime`
`formSubmitted` - `DateTime`
`accountType` - `String`
`businessSize` - `String`
`role` - `String`
`budget` - `String`
`usage` - `String`
`referrer` - `String`
`utmSource` - `String`
`utmMedium` - `String`
`utmCampaign` - `String`
`utmTerm` - `String`
`utmContent` - `String`
`referrerLink` - `String`
`internalReferrerLink` - `String`
`updatedAt` - `DateTime`
`googleSessionId` - `Int`
`googleClientId` - `String`
`subscribedToNewsletter` - `Boolean`
`subscribedToMarketing` - `Boolean`
`referralBonus` - `Int`
`referralBonusNotifiedAt` - `DateTime`
`upgradedToAffiliateNotifiedAt` - `DateTime`
`checklistType` - `String`
`checklistHidden` - `Boolean`
`completedChecklist` - `Boolean`
`checklistPathsCompleted` - `ChecklistPath`
`slsActivatedDate` - `DateTime`
`podActivatedDate` - `DateTime`

Example

{
  "userId": "xyz789",
  "formStarted": "2007-12-03T10:15:30Z",
  "formSubmitted": "2007-12-03T10:15:30Z",
  "accountType": "xyz789",
  "businessSize": "abc123",
  "role": "xyz789",
  "budget": "abc123",
  "usage": "xyz789",
  "referrer": "xyz789",
  "utmSource": "abc123",
  "utmMedium": "xyz789",
  "utmCampaign": "abc123",
  "utmTerm": "xyz789",
  "utmContent": "xyz789",
  "referrerLink": "xyz789",
  "internalReferrerLink": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z",
  "googleSessionId": 123,
  "googleClientId": "xyz789",
  "subscribedToNewsletter": false,
  "subscribedToMarketing": true,
  "referralBonus": 987,
  "referralBonusNotifiedAt": "2007-12-03T10:15:30Z",
  "upgradedToAffiliateNotifiedAt": "2007-12-03T10:15:30Z",
  "checklistType": "xyz789",
  "checklistHidden": true,
  "completedChecklist": false,
  "checklistPathsCompleted": ChecklistPath,
  "slsActivatedDate": "2007-12-03T10:15:30Z",
  "podActivatedDate": "2007-12-03T10:15:30Z"
}

Types

PageInfo

Fields

Field Name	Description
`endCursor` - `DateTime`
`hasNextPage` - `Boolean`

Example

{
  "endCursor": "2007-12-03T10:15:30Z",
  "hasNextPage": true
}

Types

PaymentMethod

Fields

Field Name	Description
`id` - `String`
`userId` - `String`
`stripePaymentId` - `String`
`type` - `String`
`card` - `Card`
`createdAt` - `DateTime`
`updatedAt` - `DateTime`
`deletedAt` - `DateTime`
`isDefault` - `Boolean`
`failedPaymentCount` - `Int`
`name` - `String`
`priority` - `Int`

Example

{
  "id": "xyz789",
  "userId": "xyz789",
  "stripePaymentId": "xyz789",
  "type": "xyz789",
  "card": Card,
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "deletedAt": "2007-12-03T10:15:30Z",
  "isDefault": true,
  "failedPaymentCount": 123,
  "name": "abc123",
  "priority": 123
}

Types

PayoutHistory

Fields

Field Name	Description
`id` - `String`
`medium` - `TransactionMedium`
`transactionStartedAt` - `DateTime`
`receiptLink` - `String`
`amount` - `Float`
`type` - `TransactionType`

Example

{
  "id": "xyz789",
  "medium": "STRIPE",
  "transactionStartedAt": "2007-12-03T10:15:30Z",
  "receiptLink": "abc123",
  "amount": 123.45,
  "type": "RELOAD"
}

Types

Pod

Fields

Field Name	Description
`lowestBidPriceToResume` - `Float`
`aiApiId` - `String`
`apiKey` - `String`
`clusterIp` - `String`
`clusterIdx` - `Int`
`clusterCidr` - `String`
`clusterRole` - `ClusterRole`
`consumerUserId` - `String`
`containerDiskInGb` - `Int`
`containerRegistryAuthId` - `String`
`costMultiplier` - `Float`
`costPerHr` - `Float!`
`createdAt` - `DateTime`
`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`	Use Pod.runtime.uptimeSeconds instead
`vcpuCount` - `Float!`
`version` - `Int`
`volumeEncrypted` - `Boolean!`
`volumeInGb` - `Float`
`volumeKey` - `String`
`volumeMountPath` - `String`
`lastStartedAt` - `DateTime`
`cpuFlavorId` - `String`
`machineType` - `String`
`slsVersion` - `Int`
`networkVolumeId` - `String`
`testPod` - `Boolean`
`ideAiApiId` - `String`
`hubReleaseId` - `String`
`hubRelease` - `HubRelease`
`modelVersions` - `[ModelVersionPodAssignment!]`
`cpuFlavor` - `CpuFlavor`
`runtime` - `PodRuntime`
`machine` - `PodMachineInfo`
`latestTelemetry` - `PodTelemetry`
`endpoint` - `Endpoint`
`networkVolume` - `NetworkVolume`
`savingsPlans` - `[SavingsPlan]`
`clusterId` - `String`
`ipAddress` - `IPAddress`
`models` - `[String!]`

Example

{
  "lowestBidPriceToResume": 123.45,
  "aiApiId": "abc123",
  "apiKey": "xyz789",
  "clusterIp": "abc123",
  "clusterIdx": 123,
  "clusterCidr": "xyz789",
  "clusterRole": "SLURM_CONTROLLER",
  "consumerUserId": "abc123",
  "containerDiskInGb": 123,
  "containerRegistryAuthId": "abc123",
  "costMultiplier": 987.65,
  "costPerHr": 987.65,
  "createdAt": "2007-12-03T10:15:30Z",
  "adjustedCostPerHr": 123.45,
  "desiredStatus": "CREATED",
  "dockerArgs": "xyz789",
  "dockerId": "xyz789",
  "env": ["xyz789"],
  "gpuCount": 123,
  "gpuPowerLimitPercent": 123,
  "gpus": [Gpu],
  "id": "xyz789",
  "imageName": "xyz789",
  "lastStatusChange": "abc123",
  "locked": false,
  "machineId": "xyz789",
  "memoryInGb": 987.65,
  "name": "abc123",
  "podType": "INTERRUPTABLE",
  "port": 43612,
  "ports": "abc123",
  "registry": PodRegistry,
  "templateId": "xyz789",
  "uptimeSeconds": 123,
  "vcpuCount": 123.45,
  "version": 123,
  "volumeEncrypted": true,
  "volumeInGb": 123.45,
  "volumeKey": "xyz789",
  "volumeMountPath": "xyz789",
  "lastStartedAt": "2007-12-03T10:15:30Z",
  "cpuFlavorId": "xyz789",
  "machineType": "abc123",
  "slsVersion": 123,
  "networkVolumeId": "abc123",
  "testPod": true,
  "ideAiApiId": "abc123",
  "hubReleaseId": "abc123",
  "hubRelease": HubRelease,
  "modelVersions": [ModelVersionPodAssignment],
  "cpuFlavor": CpuFlavor,
  "runtime": PodRuntime,
  "machine": PodMachineInfo,
  "latestTelemetry": PodTelemetry,
  "endpoint": Endpoint,
  "networkVolume": NetworkVolume,
  "savingsPlans": [SavingsPlan],
  "clusterId": "xyz789",
  "ipAddress": IPAddress,
  "models": ["abc123"]
}

Types

PodBidResumeInput

Fields

Input Field	Description
`podId` - `String!`
`gpuCount` - `Int!`
`bidPerGpu` - `Float!`

Example

{
  "podId": "abc123",
  "gpuCount": 987,
  "bidPerGpu": 987.65
}

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": "abc123",
  "dockerArgs": "abc123",
  "imageName": "abc123",
  "env": [EnvironmentVariableInput],
  "port": 43612,
  "ports": "abc123",
  "containerDiskInGb": 987,
  "volumeInGb": 123,
  "volumeMountPath": "abc123",
  "containerRegistryAuthId": "xyz789"
}

Types

PodFilter

Fields

Input Field	Description
`podId` - `String!`

Example

{"podId": "abc123"}

Types

PodFindAndDeployOnDemandInput

Fields

Input Field	Description
`aiApiId` - `String`
`cloudType` - `CloudTypeEnum`
`containerDiskInGb` - `Int`
`containerRegistryAuthId` - `String`
`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`
`terminateAfter` - `DateTime`
`volumeInGb` - `Int`
`volumeKey` - `String`
`volumeMountPath` - `String`
`dataCenterId` - `String`
`savingsPlan` - `SavingsPlanInput`
`cudaVersion` - `String`
`allowedCudaVersions` - `[String]`
`minCudaVersion` - `String`
`instanceIds` - `[String]`
`computeType` - `ComputeType`
`globalNetwork` - `Boolean`
`ideAiApiId` - `String`

Example

{
  "aiApiId": "xyz789",
  "cloudType": "SECURE",
  "containerDiskInGb": 123,
  "containerRegistryAuthId": "xyz789",
  "countryCode": "abc123",
  "deployCost": 987.65,
  "dockerArgs": "xyz789",
  "env": [EnvironmentVariableInput],
  "gpuCount": 987,
  "gpuTypeId": "xyz789",
  "gpuTypeIdList": ["xyz789"],
  "imageName": "abc123",
  "minDisk": 123,
  "minDownload": 123,
  "minMemoryInGb": 123,
  "minUpload": 987,
  "minVcpuCount": 987,
  "name": "xyz789",
  "networkVolumeId": "abc123",
  "port": 43612,
  "ports": "abc123",
  "startJupyter": false,
  "startSsh": false,
  "stopAfter": "2007-12-03T10:15:30Z",
  "supportPublicIp": true,
  "templateId": "abc123",
  "terminateAfter": "2007-12-03T10:15:30Z",
  "volumeInGb": 987,
  "volumeKey": "abc123",
  "volumeMountPath": "abc123",
  "dataCenterId": "abc123",
  "savingsPlan": SavingsPlanInput,
  "cudaVersion": "xyz789",
  "allowedCudaVersions": ["abc123"],
  "minCudaVersion": "abc123",
  "instanceIds": ["xyz789"],
  "computeType": "CPU",
  "globalNetwork": true,
  "ideAiApiId": "abc123"
}

Types

PodMachineInfo

Fields

Field Name	Description
`id` - `String`
`costPerHr` - `Float`
`currentPricePerGpu` - `Float`
`diskMBps` - `Int`
`gpuAvailable` - `Int`
`gpuDisplayName` - `String`
`gpuTypeId` - `String`
`gpuType` - `GpuType`
`listed` - `Boolean`
`location` - `String`
`machineType` - `String`
`maintenanceEnd` - `DateTime`
`maintenanceNote` - `String`
`maintenanceStart` - `DateTime`
`maxDownloadSpeedMbps` - `Int`
`maxUploadSpeedMbps` - `Int`
`note` - `String`
`podHostId` - `String`
`runpodIp` - `String`
`secureCloud` - `Boolean`
`supportPublicIp` - `Boolean`
`minPodGpuCount` - `Int`
`machineSystem` - `MachineSystem`
`dataCenterId` - `String`
`cpuTypeId` - `String`
`cpuType` - `CpuType`
`cpuCount` - `Int`
`vcpuTotal` - `Int`
`vcpuReserved` - `Float`
`memoryTotal` - `Int`
`memoryReserved` - `Float`
`globalNetwork` - `Boolean`

Example

{
  "id": "abc123",
  "costPerHr": 123.45,
  "currentPricePerGpu": 123.45,
  "diskMBps": 987,
  "gpuAvailable": 987,
  "gpuDisplayName": "xyz789",
  "gpuTypeId": "abc123",
  "gpuType": GpuType,
  "listed": false,
  "location": "xyz789",
  "machineType": "xyz789",
  "maintenanceEnd": "2007-12-03T10:15:30Z",
  "maintenanceNote": "abc123",
  "maintenanceStart": "2007-12-03T10:15:30Z",
  "maxDownloadSpeedMbps": 987,
  "maxUploadSpeedMbps": 123,
  "note": "abc123",
  "podHostId": "xyz789",
  "runpodIp": "xyz789",
  "secureCloud": true,
  "supportPublicIp": true,
  "minPodGpuCount": 123,
  "machineSystem": MachineSystem,
  "dataCenterId": "abc123",
  "cpuTypeId": "abc123",
  "cpuType": CpuType,
  "cpuCount": 123,
  "vcpuTotal": 987,
  "vcpuReserved": 987.65,
  "memoryTotal": 987,
  "memoryReserved": 987.65,
  "globalNetwork": false
}

Types

PodMigration

Fields

Field Name	Description
`id` - `String`
`sourcePodId` - `String`
`targetPodId` - `String`
`sourceMachineId` - `String`
`targetMachineId` - `String`
`migrationType` - `String`
`sourceMount` - `String`
`status` - `PodMigrationStatus`
`progress` - `Int`
`message` - `String`
`createdAt` - `DateTime`
`updatedAt` - `DateTime`

Example

{
  "id": "xyz789",
  "sourcePodId": "abc123",
  "targetPodId": "abc123",
  "sourceMachineId": "abc123",
  "targetMachineId": "xyz789",
  "migrationType": "abc123",
  "sourceMount": "abc123",
  "status": "PENDING",
  "progress": 123,
  "message": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

PodMigrationStatus

Values

Enum Value	Description
`PENDING`
`IN_PROGRESS`
`COMPLETED`
`FAILED`
`CANCELLED`

Example

"PENDING"

Types

PodRegistry

Fields

Field Name	Description
`auth` - `String`
`pass` - `String`
`url` - `String`
`user` - `String`
`username` - `String`

Example

{
  "auth": "abc123",
  "pass": "abc123",
  "url": "abc123",
  "user": "xyz789",
  "username": "xyz789"
}

Types

PodRentInterruptableInput

Fields

Input Field	Description
`bidPerGpu` - `Float`
`cloudType` - `CloudTypeEnum`
`containerDiskInGb` - `Int`
`containerRegistryAuthId` - `String`
`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`
`terminateAfter` - `String`
`volumeInGb` - `Int`
`volumeKey` - `String`
`volumeMountPath` - `String`
`dataCenterId` - `String`
`cudaVersion` - `String`
`allowedCudaVersions` - `[String]`
`minCudaVersion` - `String`

Example

{
  "bidPerGpu": 123.45,
  "cloudType": "SECURE",
  "containerDiskInGb": 987,
  "containerRegistryAuthId": "abc123",
  "countryCode": "xyz789",
  "dockerArgs": "abc123",
  "env": [EnvironmentVariableInput],
  "gpuCount": 987,
  "gpuTypeId": "abc123",
  "imageName": "xyz789",
  "minDisk": 987,
  "minDownload": 987,
  "minMemoryInGb": 123,
  "minUpload": 123,
  "minVcpuCount": 987,
  "name": "abc123",
  "networkVolumeId": "xyz789",
  "port": 43612,
  "ports": "xyz789",
  "startJupyter": false,
  "startSsh": false,
  "stopAfter": "abc123",
  "supportPublicIp": false,
  "templateId": "xyz789",
  "terminateAfter": "xyz789",
  "volumeInGb": 987,
  "volumeKey": "xyz789",
  "volumeMountPath": "xyz789",
  "dataCenterId": "abc123",
  "cudaVersion": "xyz789",
  "allowedCudaVersions": ["xyz789"],
  "minCudaVersion": "xyz789"
}

Types

PodResumeInput

Fields

Input Field	Description
`podId` - `String!`
`gpuCount` - `Int`
`syncMachine` - `Boolean`
`computeType` - `ComputeType`

Example

{
  "podId": "xyz789",
  "gpuCount": 987,
  "syncMachine": false,
  "computeType": "CPU"
}

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": 987}

Types

PodRuntimeGpus

Fields

Field Name	Description
`id` - `String`
`gpuUtilPercent` - `Int`
`memoryUtilPercent` - `Int`

Example

{
  "id": "xyz789",
  "gpuUtilPercent": 123,
  "memoryUtilPercent": 123
}

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!`
`incrementVersion` - `Boolean`

Example

{
  "podId": "abc123",
  "incrementVersion": false
}

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": 123.45,
  "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`
`boundEndpointId` - `String`
`name` - `String`
`ports` - `String`
`portsConfig` - `[PortConfig]`
`readme` - `String`
`runtimeInMin` - `Int`
`startJupyter` - `Boolean`
`startScript` - `String`
`startSsh` - `Boolean`
`volumeInGb` - `Int`
`volumeMountPath` - `String`
`config` - `JSON`
`category` - `String`
`userId` - `String`
`presentationOrder` - `Int`

Example

{
  "advancedStart": true,
  "containerDiskInGb": 987,
  "containerRegistryAuthId": "abc123",
  "dockerArgs": "abc123",
  "earned": 987.65,
  "env": [EnvironmentVariable],
  "id": "xyz789",
  "imageName": "abc123",
  "isPublic": false,
  "isRunpod": true,
  "isServerless": false,
  "boundEndpointId": "xyz789",
  "name": "abc123",
  "ports": "abc123",
  "portsConfig": [PortConfig],
  "readme": "xyz789",
  "runtimeInMin": 987,
  "startJupyter": false,
  "startScript": "abc123",
  "startSsh": true,
  "volumeInGb": 123,
  "volumeMountPath": "abc123",
  "config": {},
  "category": "abc123",
  "userId": "xyz789",
  "presentationOrder": 123
}

Types

PodTerminateInput

Fields

Input Field	Description
`podId` - `String!`

Example

{"podId": "abc123"}

Types

PodType

Values

Enum Value	Description
`INTERRUPTABLE`
`RESERVED`
`BID`
`BACKGROUND`

Example

"INTERRUPTABLE"

Types

PodnetCluster

Fields

Field Name	Description
`id` - `String`
`name` - `String`
`description` - `String`
`PodnetNodes` - `[PodnetNode]`
`NetworkRanges` - `[NetworkRange]`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "description": "xyz789",
  "PodnetNodes": [PodnetNode],
  "NetworkRanges": [NetworkRange]
}

Types

PodnetNode

Fields

Field Name	Description
`id` - `String`
`podnetClusterId` - `String`
`podnetCluster` - `PodnetCluster`
`publicIp` - `String`
`nebulaIp` - `String`

Example

{
  "id": "xyz789",
  "podnetClusterId": "xyz789",
  "podnetCluster": PodnetCluster,
  "publicIp": "abc123",
  "nebulaIp": "abc123"
}

Types

PodsConnection

Fields

Field Name	Description
`edges` - `[Pod]`	List of pods that match the query.
`pageInfo` - `PodsPageInfo`	Pagination information for navigating through results.

Example

{
  "edges": [Pod],
  "pageInfo": PodsPageInfo
}

Types

PodsConnectionInput

Fields

Input Field	Description
`cursor` - `String`
`limit` - `Int`
`filter` - `PodsFilter`

Example

{
  "cursor": "xyz789",
  "limit": 987,
  "filter": PodsFilter
}

Types

PodsFilter

Fields

Input Field	Description
`status` - `[PodStatus]`
`name` - `String`

Example

{"status": ["CREATED"], "name": "abc123"}

Types

PodsPageInfo

Fields

Field Name	Description
`endCursor` - `String`
`hasNextPage` - `Boolean`

Example

{"endCursor": "xyz789", "hasNextPage": true}

Types

Pool

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`reservationId` - `String!`
`dataCenterId` - `String!`
`createdAt` - `DateTime!`
`updatedAt` - `DateTime!`
`machines` - `[Machine!]!`
`reservation` - `Reservation!`
`dataCenter` - `DataCenter!`
`capacity` - `PoolCapacity!`

Example

{
  "id": 4,
  "name": "abc123",
  "reservationId": "xyz789",
  "dataCenterId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "machines": [Machine],
  "reservation": Reservation,
  "dataCenter": DataCenter,
  "capacity": PoolCapacity
}

Types

PoolCapacity

Fields

Field Name	Description
`totalGpus` - `Int!`
`availableGpus` - `Int!`
`reservedGpus` - `Int!`
`gpuMachineCount` - `Int!`
`totalVcpus` - `Int!`
`availableVcpus` - `Int!`
`reservedVcpus` - `Int!`
`cpuMachineCount` - `Int!`

Example

{
  "totalGpus": 123,
  "availableGpus": 987,
  "reservedGpus": 123,
  "gpuMachineCount": 123,
  "totalVcpus": 987,
  "availableVcpus": 987,
  "reservedVcpus": 123,
  "cpuMachineCount": 123
}

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

Types

PortConfig

Fields

Field Name	Description
`port` - `String!`
`name` - `String!`

Example

{
  "port": "abc123",
  "name": "abc123"
}

Types

ReferralEmailUsage

Fields

Field Name	Description
`id` - `String`
`hashedEmail` - `String`
`createdAt` - `DateTime`
`updatedAt` - `DateTime`
`referralId` - `String`
`affiliateKey` - `String`
`usages` - `Int`

Example

{
  "id": "abc123",
  "hashedEmail": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "referralId": "abc123",
  "affiliateKey": "xyz789",
  "usages": 123
}

Types

Repo

Fields

Field Name	Description
`repoName` - `String`
`repoId` - `String`
`branch` - `String`
`dockerFilePath` - `String`
`buildContext` - `String`
`dockerArgs` - `String`
`containerRegistryAuthId` - `String`

Example

{
  "repoName": "xyz789",
  "repoId": "abc123",
  "branch": "xyz789",
  "dockerFilePath": "abc123",
  "buildContext": "xyz789",
  "dockerArgs": "xyz789",
  "containerRegistryAuthId": "xyz789"
}

Types

Reservation

Fields

Field Name	Description
`id` - `ID!`
`name` - `String`
`contractId` - `String`
`startDate` - `DateTime!`
`endDate` - `DateTime!`
`createdAt` - `DateTime!`
`updatedAt` - `DateTime!`
`resources` - `[ReservationResource]`	Resources reserved by this reservation
`pool` - `Pool`	Pool where this reservation's resources are allocated
`userReservations` - `[UserReservation]`	Users associated with this reservation
`isActive` - `Boolean`	Whether the current date is within the reservation period

Example

{
  "id": 4,
  "name": "xyz789",
  "contractId": "xyz789",
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "resources": [ReservationResource],
  "pool": Pool,
  "userReservations": [UserReservation],
  "isActive": true
}

Types

ReservationResource

Fields

Field Name	Description
`id` - `ID!`
`reservationId` - `String!`
`resourceType` - `ResourceType!`
`resourceId` - `String!`
`costPerHr` - `Float!`
`quota` - `Int!`
`createdAt` - `DateTime!`
`updatedAt` - `DateTime!`
`gpuType` - `GpuType`
`cpuFlavor` - `CpuFlavor`

Example

{
  "id": 4,
  "reservationId": "abc123",
  "resourceType": "GPU",
  "resourceId": "xyz789",
  "costPerHr": 123.45,
  "quota": 123,
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "gpuType": GpuType,
  "cpuFlavor": CpuFlavor
}

Types

ResourceType

Values

Enum Value	Description
`GPU`
`CPU`

Example

"GPU"

Types

Result

Fields

Field Name	Description
`id` - `Int!`
`name` - `String!`
`status` - `String!`
`error` - `String`
`executionTime` - `Float`

Example

{
  "id": 123,
  "name": "abc123",
  "status": "xyz789",
  "error": "xyz789",
  "executionTime": 123.45
}

Types

SaveRegistryAuthInput

Fields

Input Field	Description
`name` - `String!`
`username` - `String!`
`password` - `String!`

Example

{
  "name": "xyz789",
  "username": "xyz789",
  "password": "abc123"
}

Types

SavingsPlan

Fields

Field Name	Description
`id` - `ID`
`endTime` - `DateTime`
`startTime` - `DateTime`
`gpuType` - `GpuType`
`podId` - `String`
`gpuTypeId` - `String`
`pod` - `Pod`
`savingsPlanType` - `String`
`costPerHr` - `Float`
`upfrontCost` - `Float`
`planLength` - `String`
`createdByUserId` - `String`
`source` - `SavingsPlanSource`
`createdAt` - `DateTime`
`dealId` - `String`

Example

{
  "id": "4",
  "endTime": "2007-12-03T10:15:30Z",
  "startTime": "2007-12-03T10:15:30Z",
  "gpuType": GpuType,
  "podId": "abc123",
  "gpuTypeId": "xyz789",
  "pod": Pod,
  "savingsPlanType": "xyz789",
  "costPerHr": 123.45,
  "upfrontCost": 987.65,
  "planLength": "abc123",
  "createdByUserId": "xyz789",
  "source": "SELF_SERVICE",
  "createdAt": "2007-12-03T10:15:30Z",
  "dealId": "xyz789"
}

Types

SavingsPlanInput

Fields

Input Field	Description
`planLength` - `String`
`upfrontCost` - `Float`

Example

{
  "planLength": "abc123",
  "upfrontCost": 987.65
}

Types

SavingsPlanSource

Values

Enum Value	Description
`SELF_SERVICE`
`RUNPOD`

Example

"SELF_SERVICE"

Types

Scope

Values

Enum Value	Description
`CSR_ENGINEER`
`TEAM_ADMIN`
`TEAM_DEV`
`TEAM_BILLING`
`TEAM_BASIC`
`HOST`
`USER_READ`
`USER_WRITE`

Example

"CSR_ENGINEER"

Types

Secret

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`createdAt` - `DateTime!`
`updatedAt` - `DateTime`
`description` - `String`
`lastRetrievedAt` - `DateTime`
`lastUpdatedAt` - `DateTime`

Example

{
  "id": "4",
  "name": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "description": "xyz789",
  "lastRetrievedAt": "2007-12-03T10:15:30Z",
  "lastUpdatedAt": "2007-12-03T10:15:30Z"
}

Types

SharedApiKey

Fields

Field Name	Description
`id` - `String`
`secretId` - `String`
`createdAt` - `DateTime!`
`name` - `String`
`description` - `String`

Example

{
  "id": "xyz789",
  "secretId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "description": "abc123"
}

Types

SignUpMethod

Values

Enum Value	Description
`GOOGLE`
`GITHUB`
`EMAIL`
`UNKNOWN`

Example

"GOOGLE"

Types

Specifics

Fields

Field Name	Description
`stockStatus` - `String`
`securePrice` - `Float`
`slsPrice` - `Float`

Example

{
  "stockStatus": "abc123",
  "securePrice": 987.65,
  "slsPrice": 123.45
}

Types

SpecificsInput

Fields

Input Field	Description
`instanceId` - `String`
`dataCenterId` - `String`

Example

{
  "instanceId": "xyz789",
  "dataCenterId": "xyz789"
}

Types

SpendDetails

Fields

Field Name	Description
`localStoragePerHour` - `Float`
`networkStoragePerHour` - `Float`
`gpuComputePerHour` - `Float`

Example

{
  "localStoragePerHour": 123.45,
  "networkStoragePerHour": 987.65,
  "gpuComputePerHour": 123.45
}

Types

StorageClusterInfo

Fields

Field Name	Description
`id` - `String`
`connectionDetails` - `JSON`
`isPrimary` - `Boolean`
`type` - `String`
`mountPath` - `String`
`storageType` - `StorageType`
`isNextGenStorage` - `Boolean`

Example

{
  "id": "xyz789",
  "connectionDetails": {},
  "isPrimary": true,
  "type": "abc123",
  "mountPath": "abc123",
  "storageType": "MOOSE_FS",
  "isNextGenStorage": true
}

Types

StorageType

Values

Enum Value	Description
`MOOSE_FS`
`ONE_FS`
`CEPH_FS`
`VAST`
`DDN`
`PURE`

Example

"MOOSE_FS"

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": "abc123",
  "amount": 123.45,
  "medium": "STRIPE",
  "type": "RELOAD"
}

Types

Team

Fields

Field Name	Description
`id` - `String`
`name` - `String`
`owner` - `TeamOwner!`
`memberships` - `[TeamMembership!]`
`membership` - `TeamMembership`
`members` - `[TeamMembership!]`
`invites` - `[TeamInvite]`
`isOwner` - `Boolean`
`availableRoles` - `[String]`

Example

{
  "id": "abc123",
  "name": "xyz789",
  "owner": TeamOwner,
  "memberships": [TeamMembership],
  "membership": TeamMembership,
  "members": [TeamMembership],
  "invites": [TeamInvite],
  "isOwner": true,
  "availableRoles": ["xyz789"]
}

Types

TeamInvite

Fields

Field Name	Description
`id` - `ID!`
`team` - `TeamInviteTeam!`
`role` - `TeamRole!`
`createdAt` - `DateTime!`
`expiresAt` - `DateTime!`

Example

{
  "id": 4,
  "team": TeamInviteTeam,
  "role": "owner",
  "createdAt": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z"
}

Types

TeamInviteOwner

Fields

Field Name	Description
`email` - `String`

Example

{"email": "abc123"}

Types

TeamInviteTeam

Fields

Field Name	Description
`id` - `ID!`
`name` - `String`
`owner` - `TeamInviteOwner`

Example

{
  "id": 4,
  "name": "abc123",
  "owner": TeamInviteOwner
}

Types

TeamMembership

Fields

Field Name	Description
`id` - `ID!`
`member` - `User!`
`team` - `Team!`
`scopes` - `JSON`
`createdAt` - `DateTime!`
`updatedAt` - `DateTime!`

Example

{
  "id": 4,
  "member": User,
  "team": Team,
  "scopes": {},
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

TeamOwner

Fields

Field Name	Description
`id` - `String`
`email` - `String`
`authId` - `String`

Example

{
  "id": "abc123",
  "email": "xyz789",
  "authId": "abc123"
}

Types

TeamRole

Values

Enum Value	Description
`owner`
`admin`
`member`
`dev`
`billing`
`basic`

Example

"owner"

Types

TeamScopes

Fields

Field Name	Description
`role` - `String`

Example

{"role": "xyz789"}

Types

Test

Fields

Field Name	Description
`id` - `String!`
`status` - `String!`
`startedAt` - `DateTime!`
`completedAt` - `DateTime`
`githubBuildId` - `String`
`error` - `String`
`results` - `[Result]`

Example

{
  "id": "abc123",
  "status": "abc123",
  "startedAt": "2007-12-03T10:15:30Z",
  "completedAt": "2007-12-03T10:15:30Z",
  "githubBuildId": "xyz789",
  "error": "xyz789",
  "results": [Result]
}

Types

TransactionMedium

Values

Enum Value	Description
`STRIPE`
`CRYPTO`
`RUNPOD`
`COINBASE`
`WIRE`
`REFERRAL`

Example

"STRIPE"

Types

TransactionType

Values

Enum Value	Description
`RELOAD`
`CREDIT`
`DEBIT`
`PAYOUT`

Example

"RELOAD"

Types

User

Fields

Field Name	Description
`pods` - `[Pod]`
`backgroundPods` - `[Pod]`	Background pods generated from user's machines with idle GPUs.
`podsConnection` - `PodsConnection`	Paginated connection for user's pods with filtering and cursor-based pagination.
Arguments `input` - `PodsConnectionInput`
`machines` - `[Machine]`
Arguments `input` - `UserMachinesFilter`
`hiddenMachines` - `[Machine]`
`machinesSummary` - `[MachineSummary]`
`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]`
`machineEarningsCustomRange` - `[MachineEarning]`
Arguments `input` - `EarningsCustomRangeInput`
`networkStorageEarnings` - `[NetworkStorageEarning]`
Arguments `input` - `NetworkStorageEarningInput`
`underBalance` - `Boolean`
`minBalance` - `Float`
`stripeAutoReloadAmount` - `Int`
`stripeAutoPaymentThreshold` - `Int`
`spendDetails` - `SpendDetails`
`maxServerlessConcurrency` - `Int`
`clientLifetimeSpend` - `Float`
`referralId` - `String`
`datacenters` - `[DataCenter]`
`githubAccountInfo` - `GithubAccountInfo`
`discordAccountInfo` - `DiscordAccountInfo`
`isAutoPayEnabled` - `Boolean`
`enableBackupPayments` - `Boolean`
`onboardingInfo` - `OnboardingInfo`
`affiliateKey` - `String`
`hasActivated` - `Boolean`
`canRefer` - `Boolean`
`referralUsageId` - `String`
`activeMigrations` - `[PodMigration]`
`notifyCcList` - `String`
`userPreferences` - `[UserPreference!]!`
`clientBalance` - `Float`
`hostBalance` - `Float`
`hostStripeLinked` - `Boolean`
`stripeAccountId` - `String`
`stripeReloadHistory` - `[StripeReloadTransaction]`
Arguments `startDate` - `DateTime` `endDate` - `DateTime`
`payoutHistory` - `[PayoutHistory]`
`dailyCharges` - `[ClientCreditCharge]!`
`referral` - `UserReferral!`
`pubKey` - `String`
`information` - `UserInformation`
`notifyPodsStale` - `Boolean`
`notifyPodsGeneral` - `Boolean`
`notifyLowBalance` - `Boolean`
`creditAlertThreshold` - `Float`
`notifyOther` - `Boolean`
`podTemplates` - `[PodTemplate]`
`creditCodes` - `[CreditCode]`
`endpoint` - `Endpoint`
Arguments `id` - `String!`
`endpoints` - `[Endpoint]!`
`networkVolumes` - `[NetworkVolume]`
`teams` - `[Team]`
`ownedTeams` - `[Team]`
`team` - `Team`
`teamMembership` - `TeamMembership`
`teamScopes` - `TeamScopes`
`isTeam` - `Boolean`
`savingsPlans` - `[SavingsPlan]`
`savingsPlan` - `SavingsPlan`
`serverlessDiscount` - `Discount`
`serverlessDiscounts` - `[Discount]`
`billing` - `UserBilling`
Arguments `input` - `UserBillingInput!`
`secrets` - `[Secret!]!`
`impersonations` - `[Impersonation]`
`activeImpersonation` - `Impersonation`
`nodeGroups` - `[NodeGroup]`
`cluster` - `Cluster`
Arguments `input` - `ClusterInput!`
`clusters` - `[Cluster]`
`apiKeys` - `[ApiKey!]`
`sharedApiKeys` - `[SharedApiKey!]`
`paymentMethods` - `[PaymentMethod!]`
`paymentMethodsByPriority` - `[PaymentMethod!]`
`defaultPaymentMethod` - `PaymentMethod`
`reservations` - `[UserReservation!]!`
Arguments `isActive` - `Boolean`

Example

{
  "pods": [Pod],
  "backgroundPods": [Pod],
  "podsConnection": PodsConnection,
  "machines": [Machine],
  "hiddenMachines": [Machine],
  "machinesSummary": [MachineSummary],
  "id": "abc123",
  "authId": "abc123",
  "email": "xyz789",
  "containerRegistryCreds": [ContainerRegistryAuth],
  "currentSpendPerHr": 987.65,
  "machineQuota": 123,
  "referralEarned": 123.45,
  "signedTermsOfService": false,
  "spendLimit": 987,
  "stripeSavedPaymentId": "xyz789",
  "stripeSavedPaymentLast4": "xyz789",
  "templateEarned": 123.45,
  "multiFactorEnabled": false,
  "machineEarnings": [MachineEarning],
  "machineEarningsCustomRange": [MachineEarning],
  "networkStorageEarnings": [NetworkStorageEarning],
  "underBalance": true,
  "minBalance": 123.45,
  "stripeAutoReloadAmount": 123,
  "stripeAutoPaymentThreshold": 123,
  "spendDetails": SpendDetails,
  "maxServerlessConcurrency": 123,
  "clientLifetimeSpend": 123.45,
  "referralId": "abc123",
  "datacenters": [DataCenter],
  "githubAccountInfo": GithubAccountInfo,
  "discordAccountInfo": DiscordAccountInfo,
  "isAutoPayEnabled": false,
  "enableBackupPayments": true,
  "onboardingInfo": OnboardingInfo,
  "affiliateKey": "abc123",
  "hasActivated": true,
  "canRefer": false,
  "referralUsageId": "abc123",
  "activeMigrations": [PodMigration],
  "notifyCcList": "abc123",
  "userPreferences": [UserPreference],
  "clientBalance": 123.45,
  "hostBalance": 123.45,
  "hostStripeLinked": true,
  "stripeAccountId": "abc123",
  "stripeReloadHistory": [StripeReloadTransaction],
  "payoutHistory": [PayoutHistory],
  "dailyCharges": [ClientCreditCharge],
  "referral": UserReferral,
  "pubKey": "xyz789",
  "information": UserInformation,
  "notifyPodsStale": true,
  "notifyPodsGeneral": true,
  "notifyLowBalance": true,
  "creditAlertThreshold": 123.45,
  "notifyOther": true,
  "podTemplates": [PodTemplate],
  "creditCodes": [CreditCode],
  "endpoint": Endpoint,
  "endpoints": [Endpoint],
  "networkVolumes": [NetworkVolume],
  "teams": [Team],
  "ownedTeams": [Team],
  "team": Team,
  "teamMembership": TeamMembership,
  "teamScopes": TeamScopes,
  "isTeam": true,
  "savingsPlans": [SavingsPlan],
  "savingsPlan": SavingsPlan,
  "serverlessDiscount": Discount,
  "serverlessDiscounts": [Discount],
  "billing": UserBilling,
  "secrets": [Secret],
  "impersonations": [Impersonation],
  "activeImpersonation": Impersonation,
  "nodeGroups": [NodeGroup],
  "cluster": Cluster,
  "clusters": [Cluster],
  "apiKeys": [ApiKey],
  "sharedApiKeys": [SharedApiKey],
  "paymentMethods": [PaymentMethod],
  "paymentMethodsByPriority": [PaymentMethod],
  "defaultPaymentMethod": PaymentMethod,
  "reservations": [UserReservation]
}

Types

UserBilling

Fields

Field Name	Description
`gpuCloud` - `[UserGpuCloudBilling]`
`cpuCloud` - `[UserCpuCloudBilling]`
`serverless` - `[UserServerlessBilling]`
Arguments `input` - `UserServerlessBillingInput`
`cluster` - `[UserClusterBilling]`
Arguments `input` - `UserClusterBillingInput`
`runpodEndpoint` - `[UserRunpodEndpointBilling]`
`storage` - `[UserStorageBilling]`
`summary` - `[UserSummaryBilling]`

Example

{
  "gpuCloud": [UserGpuCloudBilling],
  "cpuCloud": [UserCpuCloudBilling],
  "serverless": [UserServerlessBilling],
  "cluster": [UserClusterBilling],
  "runpodEndpoint": [UserRunpodEndpointBilling],
  "storage": [UserStorageBilling],
  "summary": [UserSummaryBilling]
}

Types

UserBillingInput

Fields

Input Field	Description
`granularity` - `BillingGranularity`

Example

{"granularity": "MINUTELY"}

Types

UserClusterBilling

Fields

Field Name	Description
`time` - `DateTime`
`amount` - `Float`
`timeBilledSeconds` - `Int`
`clusterId` - `String`
`gpuTypeId` - `String`

Example

{
  "time": "2007-12-03T10:15:30Z",
  "amount": 123.45,
  "timeBilledSeconds": 987,
  "clusterId": "xyz789",
  "gpuTypeId": "xyz789"
}

Types

UserClusterBillingGroupBy

Values

Enum Value	Description
`GPU_TYPE`
`CLUSTER_ID`

Example

"GPU_TYPE"

Types

UserClusterBillingInput

Fields

Input Field	Description
`groupBy` - `UserClusterBillingGroupBy`

Example

{"groupBy": "GPU_TYPE"}

Types

UserCpuCloudBilling

Fields

Field Name	Description
`cpuFlavorId` - `String`
`time` - `DateTime`
`timeBilledSeconds` - `Int`
`amount` - `Float`

Example

{
  "cpuFlavorId": "xyz789",
  "time": "2007-12-03T10:15:30Z",
  "timeBilledSeconds": 123,
  "amount": 987.65
}

Types

UserGpuCloudBilling

Fields

Field Name	Description
`gpuTypeId` - `String`
`time` - `DateTime`
`timeBilledSeconds` - `Int`
`amount` - `Float`

Example

{
  "gpuTypeId": "abc123",
  "time": "2007-12-03T10:15:30Z",
  "timeBilledSeconds": 987,
  "amount": 123.45
}

Types

UserInformation

Fields

Field Name	Description
`firstName` - `String`
`lastName` - `String`
`addressLine1` - `String`
`addressLine2` - `String`
`countryCode` - `String`
`companyName` - `String`
`companyIdentification` - `String`
`taxIdentification` - `String`

Example

{
  "firstName": "abc123",
  "lastName": "xyz789",
  "addressLine1": "abc123",
  "addressLine2": "xyz789",
  "countryCode": "abc123",
  "companyName": "abc123",
  "companyIdentification": "abc123",
  "taxIdentification": "abc123"
}

Types

UserMachinesFilter

Fields

Input Field	Description
`start` - `Int`
`end` - `Int`

Example

{"start": 123, "end": 123}

Types

UserPreference

Fields

Field Name	Description
`id` - `String!`
`userId` - `String!`
`category` - `UserPreferenceCategory!`
`preferences` - `JSON!`
`metadata` - `JSON`
`createdAt` - `DateTime!`
`updatedAt` - `DateTime!`

Example

{
  "id": "xyz789",
  "userId": "xyz789",
  "category": "GPU_TYPES",
  "preferences": {},
  "metadata": {},
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

UserPreferenceCategory

Values

Enum Value	Description
`GPU_TYPES`

Example

"GPU_TYPES"

Types

UserReferral

Fields

Field Name	Description
`code` - `String!`
`currentMonth` - `UserReferralMonth`

Example

{
  "code": "abc123",
  "currentMonth": UserReferralMonth
}

Types

UserReferralMonth

Fields

Field Name	Description
`totalReferrals` - `Int`
`totalSpend` - `Int`

Example

{"totalReferrals": 123, "totalSpend": 123}

Types

UserReservation

Fields

Field Name	Description
`userId` - `String!`
`reservationId` - `String!`
`createdAt` - `DateTime!`
`updatedAt` - `DateTime!`
`user` - `User`
`reservation` - `Reservation`

Example

{
  "userId": "xyz789",
  "reservationId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "user": User,
  "reservation": Reservation
}

Types

UserRunpodEndpointBilling

Fields

Field Name	Description
`time` - `DateTime`
`amount` - `Float`

Example

{
  "time": "2007-12-03T10:15:30Z",
  "amount": 987.65
}

Types

UserServerlessBilling

Fields

Field Name	Description
`time` - `DateTime`
`amount` - `Float`
`timeBilledSeconds` - `Int`
`endpointId` - `String`
`gpuTypeId` - `String`
`instanceId` - `String`

Example

{
  "time": "2007-12-03T10:15:30Z",
  "amount": 123.45,
  "timeBilledSeconds": 987,
  "endpointId": "xyz789",
  "gpuTypeId": "abc123",
  "instanceId": "abc123"
}

Types

UserServerlessBillingGroupBy

Values

Enum Value	Description
`GPU_TYPE`
`ENDPOINT`
`INSTANCE_ID`

Example

"GPU_TYPE"

Types

UserServerlessBillingInput

Fields

Input Field	Description
`groupBy` - `UserServerlessBillingGroupBy`

Example

{"groupBy": "GPU_TYPE"}

Types

UserStorageBilling

Fields

Field Name	Description
`time` - `DateTime`
`amount` - `Float`
`diskSpaceBilledGB` - `Int`
`networkStorageDiskSpaceBilledGB` - `Int`
`networkStorageAmount` - `Float`
`gpuDiskSpaceBilledGB` - `Int`
`gpuStorageAmount` - `Float`
`cpuDiskSpaceBilledGB` - `Int`
`cpuStorageAmount` - `Float`
`slsDiskSpaceBilledGB` - `Int`
`slsStorageAmount` - `Float`

Example

{
  "time": "2007-12-03T10:15:30Z",
  "amount": 987.65,
  "diskSpaceBilledGB": 123,
  "networkStorageDiskSpaceBilledGB": 123,
  "networkStorageAmount": 123.45,
  "gpuDiskSpaceBilledGB": 123,
  "gpuStorageAmount": 123.45,
  "cpuDiskSpaceBilledGB": 123,
  "cpuStorageAmount": 123.45,
  "slsDiskSpaceBilledGB": 123,
  "slsStorageAmount": 123.45
}

Types

UserSummaryBilling

Fields

Field Name	Description
`time` - `DateTime`
`gpuCloudAmount` - `Float`
`cpuCloudAmount` - `Float`
`serverlessAmount` - `Float`
`storageAmount` - `Float`
`runpodEndpointAmount` - `Float`

Example

{
  "time": "2007-12-03T10:15:30Z",
  "gpuCloudAmount": 987.65,
  "cpuCloudAmount": 987.65,
  "serverlessAmount": 123.45,
  "storageAmount": 987.65,
  "runpodEndpointAmount": 987.65
}

Types

Void

Description

Represents NULL values

Types

WebhookRequestStatus

Fields

Field Name	Description
`time` - `DateTime`
`responses` - `[Int]`

Example

{
  "time": "2007-12-03T10:15:30Z",
  "responses": [987]
}

Types

WebhookRequestsInput

Fields

Input Field	Description
`granularity` - `EndpointStatisticGranularity`

Example

{"granularity": "LIVE"}

Types

WorkerState

Fields

Field Name	Description
`time` - `DateTime`
`initializing` - `Int`
`idle` - `Int`
`running` - `Int`
`throttled` - `Int`
`unhealthy` - `Int`

Example

{
  "time": "2007-12-03T10:15:30Z",
  "initializing": 987,
  "idle": 123,
  "running": 987,
  "throttled": 987,
  "unhealthy": 987
}

Types

WorkerStateInput

Fields

Input Field	Description
`granularity` - `EndpointStatisticGranularity`

Example

{"granularity": "LIVE"}

Types

backgroundPodTelemetryInput

Fields

Input Field	Description
`machineId` - `String`
`gpuIndex` - `Int`

Example

{"machineId": "abc123", "gpuIndex": 987}