### Example OnboardingInfo JSON Source: https://graphql-spec.runpod.io/ Contains detailed information about user onboarding and account setup. Use this to understand user profile and onboarding status. ```json { "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" } ``` -------------------------------- ### SavingsPlanInput Example Source: https://graphql-spec.runpod.io/ Example of SavingsPlanInput, used for creating or updating savings plans. ```json { "planLength": "abc123", "upfrontCost": 987.65 } ``` -------------------------------- ### GraphQL backgroundPodTelemetryInput Example Source: https://graphql-spec.runpod.io/ Example of the backgroundPodTelemetryInput, including machine ID and GPU index. ```json {"machineId": "abc123", "gpuIndex": 987} ``` -------------------------------- ### PodFindAndDeployOnDemandInput Example Source: https://graphql-spec.runpod.io/ Example of the PodFindAndDeployOnDemandInput type, used for specifying parameters to find and deploy a pod on demand. ```json { "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" } ``` -------------------------------- ### Repo Type Example Source: https://graphql-spec.runpod.io/ An example of the Repo type, used for defining repository configurations for builds. ```json { "repoName": "xyz789", "repoId": "abc123", "branch": "xyz789", "dockerFilePath": "abc123", "buildContext": "xyz789", "dockerArgs": "xyz789", "containerRegistryAuthId": "xyz789" } ``` -------------------------------- ### Reservation Type Example Source: https://graphql-spec.runpod.io/ Example of the Reservation type, detailing resource reservations with start and end dates, and associated pools and users. ```json { "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 } ``` -------------------------------- ### SpecificsInput Example Source: https://graphql-spec.runpod.io/ Example of SpecificsInput, used for specifying instance and data center details. ```json { "instanceId": "xyz789", "dataCenterId": "xyz789" } ``` -------------------------------- ### SignUpMethod Enum Example Source: https://graphql-spec.runpod.io/ Example of a SignUpMethod enum value. ```json "GOOGLE" ``` -------------------------------- ### Pod Type Example Source: https://graphql-spec.runpod.io/ This example demonstrates the structure of a Pod object, including its configuration, status, resource allocation, and associated metadata. ```json { "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"] } ``` -------------------------------- ### Example JSON Object Source: https://graphql-spec.runpod.io/ A basic JSON object example. ```json { "name": "xyz789", "username": "xyz789", "password": "abc123" } ``` -------------------------------- ### User Billing Input Example Source: https://graphql-spec.runpod.io/ Example of input for user billing queries, specifying the granularity of billing data. ```json {"granularity": "MINUTELY"} ``` -------------------------------- ### DiscordAccountInfo Object Example Source: https://graphql-spec.runpod.io/ Example of DiscordAccountInfo, including discordId and username. ```json { "discordId": "xyz789", "username": "abc123" } ``` -------------------------------- ### DataCenterStorageList Object Example Source: https://graphql-spec.runpod.io/ Example of a DataCenterStorageList object, showing its fields and their expected values. ```json { "mnt": "xyz789", "pw": "abc123", "servers": ["xyz789"], "type": "abc123", "versions": [123], "primary": true } ``` -------------------------------- ### SavingsPlan Type Example Source: https://graphql-spec.runpod.io/ Example of a SavingsPlan object, including details like ID, timeframes, GPU type, and cost. ```json { "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" } ``` -------------------------------- ### IPAddress Example Source: https://graphql-spec.runpod.io/ This example shows the IPAddress type, which includes network details such as address, network range, and associated pods. ```json { "id": "abc123", "address": "abc123", "networkRangeId": "abc123", "networkRange": NetworkRange, "pod": Pod, "podnetNodes": [PodnetNode] } ``` -------------------------------- ### PodBidResumeInput Type Example Source: https://graphql-spec.runpod.io/ This example shows the input structure required for resuming a pod bid, specifying the pod ID, GPU count, and bid price per GPU. ```json { "podId": "String!", "gpuCount": "Int!", "bidPerGpu": "Float!" } ``` -------------------------------- ### User Cluster Billing Input Example Source: https://graphql-spec.runpod.io/ Example of input for user cluster billing queries, specifying how to group the billing data. ```json {"groupBy": "GPU_TYPE"} ``` -------------------------------- ### SpendDetails Type Example Source: https://graphql-spec.runpod.io/ Example of a SpendDetails object, showing costs for storage and compute. ```json { "localStoragePerHour": 123.45, "networkStoragePerHour": 987.65, "gpuComputePerHour": 123.45 } ``` -------------------------------- ### Discount Object Example Source: https://graphql-spec.runpod.io/ Example of a Discount object, showing all its fields including type and expiration date. ```json { "userId": "abc123", "type": "SERVERLESS", "discountFactor": 123.45, "expirationDate": "2007-12-03T10:15:30Z", "activeDiscountFactor": 123.45, "activeWorkers": 123 } ``` -------------------------------- ### PodEditJobInput Example Source: https://graphql-spec.runpod.io/ Example of the PodEditJobInput type, used for modifying existing pod configurations. ```json { "podId": "abc123", "dockerArgs": "abc123", "imageName": "abc123", "env": [EnvironmentVariableInput], "port": 43612, "ports": "abc123", "containerDiskInGb": 987, "volumeInGb": 123, "volumeMountPath": "abc123", "containerRegistryAuthId": "xyz789" } ``` -------------------------------- ### PortConfig Type Example Source: https://graphql-spec.runpod.io/ An example of PortConfig, used to configure network ports with a name. ```json { "port": "abc123", "name": "abc123" } ``` -------------------------------- ### Machine Uptime Example Source: https://graphql-spec.runpod.io/ Example JSON payload for machine uptime. Includes error status, sync timestamps, and uptime in seconds. ```json { "error": "abc123", "lastSyncTimestamp": 123, "seconds": 123, "sysUptimeSeconds": 123 } ``` -------------------------------- ### StorageClusterInfo Type Example Source: https://graphql-spec.runpod.io/ Example of a StorageClusterInfo object, detailing storage cluster properties. ```json { "id": "xyz789", "connectionDetails": {}, "isPrimary": true, "type": "abc123", "mountPath": "abc123", "storageType": "MOOSE_FS", "isNextGenStorage": true } ``` -------------------------------- ### Model Repo Example Source: https://graphql-spec.runpod.io/ Example JSON payload for a model repository. Includes version hash, files, and destination path. ```json { "versionHash": "xyz789", "files": [ModelRepoFile], "destPath": "abc123" } ``` -------------------------------- ### GraphQL Response Example Source: https://graphql-spec.runpod.io/ This is an example of a successful response from a GraphQL query. It details the fields available for a pod. ```json { "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"] } } } ``` -------------------------------- ### Example Pod Object Source: https://graphql-spec.runpod.io/ A basic example of a pod object, often used for initial data representation. ```json { "podId": "abc123", "gpuCount": 987, "bidPerGpu": 987.65 } ``` -------------------------------- ### Model Repo File Example Source: https://graphql-spec.runpod.io/ Example JSON payload for a file within a model repository. Includes blob hash, path, size, and URL. ```json { "blobHash": "abc123", "path": "xyz789", "size": "xyz789", "url": "abc123" } ``` -------------------------------- ### Model Example Source: https://graphql-spec.runpod.io/ Example JSON payload for a model. Includes ID, name, provider, owner, status, and version information. ```json { "id": "4", "name": "abc123", "provider": "xyz789", "owner": "xyz789", "status": "ACTIVE", "createdAt": "abc123", "updatedAt": "xyz789", "versions": [ModelVersion] } ``` -------------------------------- ### PoolCapacity Type Example Source: https://graphql-spec.runpod.io/ An example of the PoolCapacity type, detailing the total and available GPU and CPU resources. ```json { "totalGpus": 123, "availableGpus": 987, "reservedGpus": 123, "gpuMachineCount": 123, "totalVcpus": 987, "availableVcpus": 987, "reservedVcpus": 123, "cpuMachineCount": 123 } ``` -------------------------------- ### HubRelease Example Source: https://graphql-spec.runpod.io/ This example demonstrates the structure of a HubRelease object, which contains information about a software release, including its ID, name, author, and deployment details. ```json { "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 } ``` -------------------------------- ### ReservationResource Type Example Source: https://graphql-spec.runpod.io/ An example of ReservationResource, specifying details about a reserved resource, including type, cost, and quota. ```json { "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 } ``` -------------------------------- ### GpuLowestPriceInput Example Source: https://graphql-spec.runpod.io/ This is an example of the GpuLowestPriceInput type, used for filtering GPU prices. It includes various parameters for specifying GPU count, size, datacenter, and pricing details. ```json { "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 } ``` -------------------------------- ### EarningsCustomRangeInput Object Example Source: https://graphql-spec.runpod.io/ Example of EarningsCustomRangeInput, requiring start and end dates. ```json { "startDate": "2007-12-03", "endDate": "2007-12-03" } ``` -------------------------------- ### Pod Stop Response Example Source: https://graphql-spec.runpod.io/ This is an example of the JSON response received after a pod is stopped. It includes details about the pod's state and potential costs to resume. ```json { "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"] } } } ``` -------------------------------- ### MachineMaintenance JSON Example Source: https://graphql-spec.runpod.io/ This JSON object outlines a scheduled maintenance for a machine, including start and end times, and a note. ```json { "id": "xyz789", "machineId": "xyz789", "maintenanceStart": "2007-12-03T10:15:30Z", "maintenanceEnd": "2007-12-03T10:15:30Z", "maintenanceNote": "abc123" } ``` -------------------------------- ### Model Version Example Source: https://graphql-spec.runpod.io/ Example JSON payload for a model version. Includes hash, model ID, metadata, status, and various assignment details. ```json { "hash": 4, "modelId": "4", "model": Model, "metadata": {}, "status": "ACTIVE", "preAssignmentValue": 123, "createdAt": "xyz789", "updatedAt": "xyz789", "files": [ModelVersionFile], "cloudStorageAssignments": [ ModelCloudStorageAssignment ], "machineAssignments": [ModelMachineAssignment], "networkVolumeAssignments": [ ModelNetworkVolumeAssignment ] } ``` -------------------------------- ### String Scalar Example Source: https://graphql-spec.runpod.io/ Example of the String scalar type. ```json "xyz789" ``` -------------------------------- ### GpuAvailability Example Source: https://graphql-spec.runpod.io/ Provides details about GPU availability, including whether it's available, stock status, and type information. Use this to check for available GPUs. ```json { "available": false, "stockStatus": "xyz789", "gpuTypeId": "xyz789", "gpuType": GpuType, "gpuTypeDisplayName": "abc123", "displayName": "xyz789", "id": "abc123" } ``` -------------------------------- ### StorageType Enum Example Source: https://graphql-spec.runpod.io/ Example of a StorageType enum value. ```json "MOOSE_FS" ``` -------------------------------- ### GitBuild Example Source: https://graphql-spec.runpod.io/ Represents a Git build with details about the commit, branch, state, and timestamps. Use this to track the status and details of a build. ```json { "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 } ``` -------------------------------- ### SavingsPlanSource Enum Example Source: https://graphql-spec.runpod.io/ Example of a SavingsPlanSource enum value. ```json "SELF_SERVICE" ``` -------------------------------- ### User CPU Cloud Billing Example Source: https://graphql-spec.runpod.io/ Details billing information for CPU cloud usage, including CPU flavor ID, time, billed seconds, and amount. ```json { "cpuFlavorId": "xyz789", "time": "2007-12-03T10:15:30Z", "timeBilledSeconds": 123, "amount": 987.65 } ``` -------------------------------- ### Example User Information Source: https://graphql-spec.runpod.io/ Represents detailed user information including contact and company details. ```json { "firstName": "abc123", "lastName": "xyz789", "addressLine1": "abc123", "addressLine2": "xyz789", "countryCode": "abc123", "companyName": "abc123", "companyIdentification": "abc123", "taxIdentification": "abc123" } ``` -------------------------------- ### EndpointStatisticGranularity Enum Example Source: https://graphql-spec.runpod.io/ Example of an EndpointStatisticGranularity enum value. ```json "LIVE" ``` -------------------------------- ### DiscountType Enum Example Source: https://graphql-spec.runpod.io/ Example of a DiscountType enum value. ```json "SERVERLESS" ``` -------------------------------- ### RunPod PodMigration Object Example Source: https://graphql-spec.runpod.io/ Details a pod migration event, including source and target information, status, and progress. Use this to track the state of pod migrations. ```json { "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" } ``` -------------------------------- ### GraphQL Granularity Input Example Source: https://graphql-spec.runpod.io/ Example of how to specify granularity for an endpoint statistic. ```json {"granularity": "LIVE"} ``` -------------------------------- ### Example User Referral Month Source: https://graphql-spec.runpod.io/ Contains monthly referral statistics like total referrals and spend. ```json {"totalReferrals": 123, "totalSpend": 123} ``` -------------------------------- ### ReferralEmailUsage Type Example Source: https://graphql-spec.runpod.io/ Example of ReferralEmailUsage, tracking email usage for referrals. ```json { "id": "abc123", "hashedEmail": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "updatedAt": "2007-12-03T10:15:30Z", "referralId": "abc123", "affiliateKey": "xyz789", "usages": 123 } ``` -------------------------------- ### Example User Preference Source: https://graphql-spec.runpod.io/ Stores user preferences, including categories and JSON-formatted settings. ```json { "id": "xyz789", "userId": "xyz789", "category": "GPU_TYPES", "preferences": {}, "metadata": {}, "createdAt": "2007-12-03T10:15:30Z", "updatedAt": "2007-12-03T10:15:30Z" } ``` -------------------------------- ### EnvironmentVariable Object Example Source: https://graphql-spec.runpod.io/ Example of an EnvironmentVariable object, showing key and value. ```json { "key": "String", "value": "String" } ``` -------------------------------- ### Example LowestPrice Data Structure Source: https://graphql-spec.runpod.io/ This JSON object demonstrates the structure for the 'LowestPrice' type, showing sample values for GPU pricing and availability. ```json { "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] } ``` -------------------------------- ### StripeReloadTransaction Type Example Source: https://graphql-spec.runpod.io/ Example of a StripeReloadTransaction object, detailing payment transaction information. ```json { "id": "xyz789", "mediumId": "xyz789", "transactionCompletedAt": "2007-12-03T10:15:30Z", "receiptLink": "abc123", "amount": 123.45, "medium": "STRIPE", "type": "RELOAD" } ``` -------------------------------- ### AffiliateProgramEarnings Type Example Source: https://graphql-spec.runpod.io/ This JSON object illustrates the AffiliateProgramEarnings type, showing aggregated data on total referrals, paid referrals, and various earning categories. ```json { "totalReferrals": 123, "totalPaidReferrals": 123, "templateEarnings": 123.45, "referralEarnings": 123.45, "referralBonusEarnings": 123.45, "affiliateEarnings": 987.65 } ``` -------------------------------- ### GpuLowestPriceInput Example Source: https://graphql-spec.runpod.io/ Input parameters for finding the lowest price for GPUs. Specify location, count, and desired specifications like memory, disk, and CUDA version. ```json { "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 } ``` -------------------------------- ### SharedApiKey Type Example Source: https://graphql-spec.runpod.io/ Example of a SharedApiKey object, used for API key management. ```json { "id": "xyz789", "secretId": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "name": "abc123", "description": "abc123" } ``` -------------------------------- ### GpuTelemetry Example Source: https://graphql-spec.runpod.io/ Provides telemetry data for a GPU, including utilization, temperature, and power consumption. Use this to monitor GPU performance. ```json { "id": "abc123", "percentUtilization": 987.65, "temperatureCelcius": 987.65, "memoryUtilization": 987.65, "powerWatts": 987.65 } ``` -------------------------------- ### User Type Example Source: https://graphql-spec.runpod.io/ Represents a user in the system, including their pods, machine information, and account details. ```json { "pods": [Pod], "backgroundPods": [Pod], "podsConnection": PodsConnection, "machines": [Machine], "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], "networkStorageEarnings": [NetworkStorageEarning] } ``` -------------------------------- ### Scope Enum Example Source: https://graphql-spec.runpod.io/ Example of a Scope enum value, representing user permissions. ```json "CSR_ENGINEER" ``` -------------------------------- ### Port Type Example Source: https://graphql-spec.runpod.io/ A simple example of a Port, which is a valid TCP port number. ```plaintext 43612 ``` -------------------------------- ### PodFilter Example Source: https://graphql-spec.runpod.io/ Example of the PodFilter type, used for searching or filtering pods by their ID. ```json {"podId": "abc123"} ``` -------------------------------- ### RunPod PodRuntime Object Example Source: https://graphql-spec.runpod.io/ Provides information about a running pod's resource utilization and uptime. Use this to monitor pod performance. ```json { "container": PodRuntimeContainer, "gpus": [PodRuntimeGpus], "ports": [PodRuntimePorts], "uptimeInSeconds": 123 } ``` -------------------------------- ### Endpoint Object Example Source: https://graphql-spec.runpod.io/ Comprehensive example of an Endpoint object, illustrating its numerous fields. ```json { "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 } ``` -------------------------------- ### GpuAvailabilityInput Example Source: https://graphql-spec.runpod.io/ Input parameters for querying GPU availability. Specify requirements like GPU count, memory, CPU, and CUDA versions. ```json { "gpuCount": 123, "minDisk": 123, "minMemoryInGb": 123, "minVcpuCount": 987, "secureCloud": false, "allowedCudaVersions": ["xyz789"], "minCudaVersion": "xyz789", "includeAiApi": false } ``` -------------------------------- ### Example User Serverless Billing Source: https://graphql-spec.runpod.io/ Comprehensive billing information for serverless instances, including time, amount, and usage metrics. ```json { "time": "2007-12-03T10:15:30Z", "amount": 123.45, "timeBilledSeconds": 987, "endpointId": "xyz789", "gpuTypeId": "abc123", "instanceId": "abc123" } ``` -------------------------------- ### Specifics Type Example Source: https://graphql-spec.runpod.io/ Example of a Specifics object, containing stock status and pricing information. ```json { "stockStatus": "abc123", "securePrice": 987.65, "slsPrice": 123.45 } ``` -------------------------------- ### ResourceType Enum Example Source: https://graphql-spec.runpod.io/ Example of the ResourceType enum, indicating whether a resource is a GPU or CPU. ```plaintext "GPU" ``` -------------------------------- ### Example User Summary Billing Source: https://graphql-spec.runpod.io/ Aggregated billing summary for a user across different services like GPU cloud, serverless, and storage. ```json { "time": "2007-12-03T10:15:30Z", "gpuCloudAmount": 987.65, "cpuCloudAmount": 987.65, "serverlessAmount": 123.45, "storageAmount": 987.65, "runpodEndpointAmount": 987.65 } ``` -------------------------------- ### Example PodTemplate Data Structure Source: https://graphql-spec.runpod.io/ Defines a template for creating pods, including configuration for containers, networking, and runtime. ```json { "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 } ``` -------------------------------- ### PaymentMethod Type Example Source: https://graphql-spec.runpod.io/ An example of the PaymentMethod type, showcasing its fields and their expected data types. ```json { "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 } ``` -------------------------------- ### Date Type Example Source: https://graphql-spec.runpod.io/ Example of a Date type, adhering to the RFC 3339 full-date format. ```json "2007-12-03" ``` -------------------------------- ### Example API Key Object Source: https://graphql-spec.runpod.io/ Represents an API key with its associated permissions and metadata. ```json { "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 } ``` -------------------------------- ### GraphQL WorkerState Type Example Source: https://graphql-spec.runpod.io/ Example of the WorkerState type, showing time and various worker counts. ```json { "time": "2007-12-03T10:15:30Z", "initializing": 987, "idle": 123, "running": 987, "throttled": 987, "unhealthy": 987 } ``` -------------------------------- ### Result Type Example Source: https://graphql-spec.runpod.io/ An example of the Result type, showing the outcome of an operation, including its status and any errors. ```json { "id": 123, "name": "abc123", "status": "xyz789", "error": "xyz789", "executionTime": 123.45 } ``` -------------------------------- ### Pool Type Example Source: https://graphql-spec.runpod.io/ An example of the Pool type, which represents a resource pool with associated machines and capacity. ```json { "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 } ``` -------------------------------- ### MachineEarning JSON Example Source: https://graphql-spec.runpod.io/ This JSON object provides earning details for a machine on a specific date, including total, GPU, and disk earnings. ```json { "name": "abc123", "date": "2007-12-03T10:15:30Z", "machineId": "xyz789", "hostTotalEarnings": 123.45, "hostGpuEarnings": 123.45, "hostDiskEarnings": 123.45 } ``` -------------------------------- ### Example User Reservation Source: https://graphql-spec.runpod.io/ Links a user to a reservation, including timestamps and associated user/reservation objects. ```json { "userId": "xyz789", "reservationId": "xyz789", "createdAt": "2007-12-03T10:15:30Z", "updatedAt": "2007-12-03T10:15:30Z", "user": User, "reservation": Reservation } ``` -------------------------------- ### DateTime Type Example Source: https://graphql-spec.runpod.io/ Example of a DateTime type, adhering to the RFC 3339 date-time format for UTC. ```json "2007-12-03T10:15:30Z" ```