@gpuai/sdk 0.1.0

package/src/models/CreateInstanceRequest.ts

@@ -0,0 +1,167 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GPU.ai Public Developer API
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@gpu.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateInstanceRequest
+ */
+export interface CreateInstanceRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateInstanceRequest
+     */
+    gpuType: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateInstanceRequest
+     */
+    gpuCount: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateInstanceRequest
+     */
+    region?: string;
+    /**
+     * 
+     * @type {CreateInstanceRequestTierEnum}
+     * @memberof CreateInstanceRequest
+     */
+    tier: CreateInstanceRequestTierEnum;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateInstanceRequest
+     */
+    sshKeyIds?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateInstanceRequest
+     */
+    name?: string;
+    /**
+     * maximum acceptable whole-instance hourly price (catalog price)
+     * @type {number}
+     * @memberof CreateInstanceRequest
+     */
+    maxPricePerHour?: number;
+    /**
+     * Deploy a curated application template (e.g. comfyui, vllm). When set, gpu_type may be omitted — the cheapest eligible GPU is auto-selected. For templates serving a Hugging Face model via env.MODEL (vllm, sglang), the model's published weights size is checked against the GPU's VRAM at submit time: an oversized model on an explicit gpu_type returns 422 `model_too_large` (auto-select instead raises its VRAM floor to the estimate, and 422s only when no available GPU fits). Gated/private/unknown repos are never blocked — the deploy proceeds and the 202 carries a `warnings` entry.
+     * @type {string}
+     * @memberof CreateInstanceRequest
+     */
+    templateId?: string;
+    /**
+     * Launch environment. Omit for the provider default (the GPU.ai Certified Image where supported). Accepted values: `certified` (the GPU.ai Certified base image), `certified:<framework>` (a framework layer — see GET /v1/environments for the roster, e.g. `certified:pytorch`), `certified:<framework>@<version>` (a specific framework version, e.g. `certified:pytorch@2.13`), `raw_vm` (root VM, provider default OS), `raw_vm:<os>` (root VM with a chosen OS, e.g. `raw_vm:ubuntu-24.04`), or `provider_template` (the provider's own image). A well-formed value the placed machine can't serve returns 422 `environment_unavailable`.
+     * @type {string}
+     * @memberof CreateInstanceRequest
+     */
+    environment?: string;
+    /**
+     * Pin the launch to one exact offering (from GET /v1/pricing) so the engine never substitutes a pricier one. If that offering is gone, the launch fails explicitly rather than silently placing elsewhere.
+     * @type {string}
+     * @memberof CreateInstanceRequest
+     */
+    offeringId?: string;
+    /**
+     * Requested instance filesystem size in GB. Omit for the platform default (100 GB), which never narrows placement. Setting it is a hard requirement: placement narrows to capacity that can honor it (see `disk_configurable` on GET /v1/pricing), and a request no offering of the gpu_type can honor returns 422 `disk_unavailable` rather than launching with a different size. Disk beyond the included allowance (100 GB) is billed at the offering's `disk_price_per_gb_hour` (GET /v1/pricing), folded into the instance's single hourly rate. Bounds: at least 10, at most the platform ceiling (currently 1000) — outside them returns 422 `validation_failed`.
+     * @type {number}
+     * @memberof CreateInstanceRequest
+     */
+    diskGb?: number;
+    /**
+     * Per-deploy env overrides; only keys the template marks user_overridable are accepted (others 422). Secret values are redacted from operation metadata.
+     * @type {{ [key: string]: string; }}
+     * @memberof CreateInstanceRequest
+     */
+    env?: { [key: string]: string; };
+}
+
+
+/**
+ * @export
+ */
+export const CreateInstanceRequestTierEnum = {
+    Spot: 'spot',
+    OnDemand: 'on_demand'
+} as const;
+export type CreateInstanceRequestTierEnum = typeof CreateInstanceRequestTierEnum[keyof typeof CreateInstanceRequestTierEnum];
+
+
+/**
+ * Check if a given object implements the CreateInstanceRequest interface.
+ */
+export function instanceOfCreateInstanceRequest(value: object): value is CreateInstanceRequest {
+    if ((!('gpuType' in (value as Record<string, any>)) && !('gpu_type' in (value as Record<string, any>))) || ((value as Record<string, any>)['gpuType'] === undefined && (value as Record<string, any>)['gpu_type'] === undefined)) return false;
+    if ((!('gpuCount' in (value as Record<string, any>)) && !('gpu_count' in (value as Record<string, any>))) || ((value as Record<string, any>)['gpuCount'] === undefined && (value as Record<string, any>)['gpu_count'] === undefined)) return false;
+    if (!('tier' in value) || value['tier'] === undefined) return false;
+    return true;
+}
+
+export function CreateInstanceRequestFromJSON(json: any): CreateInstanceRequest {
+    return CreateInstanceRequestFromJSONTyped(json, false);
+}
+
+export function CreateInstanceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateInstanceRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'gpuType': json['gpu_type'],
+        'gpuCount': json['gpu_count'],
+        'region': json['region'] == null ? undefined : json['region'],
+        'tier': json['tier'],
+        'sshKeyIds': json['ssh_key_ids'] == null ? undefined : json['ssh_key_ids'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'maxPricePerHour': json['max_price_per_hour'] == null ? undefined : json['max_price_per_hour'],
+        'templateId': json['template_id'] == null ? undefined : json['template_id'],
+        'environment': json['environment'] == null ? undefined : json['environment'],
+        'offeringId': json['offering_id'] == null ? undefined : json['offering_id'],
+        'diskGb': json['disk_gb'] == null ? undefined : json['disk_gb'],
+        'env': json['env'] == null ? undefined : json['env'],
+    };
+}
+
+export function CreateInstanceRequestToJSON(json: any): CreateInstanceRequest {
+    return CreateInstanceRequestToJSONTyped(json, false);
+}
+
+export function CreateInstanceRequestToJSONTyped(value?: CreateInstanceRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'gpu_type': value['gpuType'],
+        'gpu_count': value['gpuCount'],
+        'region': value['region'],
+        'tier': value['tier'],
+        'ssh_key_ids': value['sshKeyIds'],
+        'name': value['name'],
+        'max_price_per_hour': value['maxPricePerHour'],
+        'template_id': value['templateId'],
+        'environment': value['environment'],
+        'offering_id': value['offeringId'],
+        'disk_gb': value['diskGb'],
+        'env': value['env'],
+    };
+}
+

package/src/models/CreateSshKeyRequest.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GPU.ai Public Developer API
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@gpu.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateSshKeyRequest
+ */
+export interface CreateSshKeyRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSshKeyRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSshKeyRequest
+     */
+    publicKey: string;
+}
+
+/**
+ * Check if a given object implements the CreateSshKeyRequest interface.
+ */
+export function instanceOfCreateSshKeyRequest(value: object): value is CreateSshKeyRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if ((!('publicKey' in (value as Record<string, any>)) && !('public_key' in (value as Record<string, any>))) || ((value as Record<string, any>)['publicKey'] === undefined && (value as Record<string, any>)['public_key'] === undefined)) return false;
+    return true;
+}
+
+export function CreateSshKeyRequestFromJSON(json: any): CreateSshKeyRequest {
+    return CreateSshKeyRequestFromJSONTyped(json, false);
+}
+
+export function CreateSshKeyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSshKeyRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'publicKey': json['public_key'],
+    };
+}
+
+export function CreateSshKeyRequestToJSON(json: any): CreateSshKeyRequest {
+    return CreateSshKeyRequestToJSONTyped(json, false);
+}
+
+export function CreateSshKeyRequestToJSONTyped(value?: CreateSshKeyRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'public_key': value['publicKey'],
+    };
+}
+

package/src/models/CreateWebhookEndpointRequest.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GPU.ai Public Developer API
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@gpu.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateWebhookEndpointRequest
+ */
+export interface CreateWebhookEndpointRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateWebhookEndpointRequest
+     */
+    url: string;
+    /**
+     * 
+     * @type {Array<CreateWebhookEndpointRequestEventTypesEnum>}
+     * @memberof CreateWebhookEndpointRequest
+     */
+    eventTypes: Array<CreateWebhookEndpointRequestEventTypesEnum>;
+}
+
+
+/**
+ * @export
+ */
+export const CreateWebhookEndpointRequestEventTypesEnum = {
+    InstanceCreating: 'instance.creating',
+    InstanceRunning: 'instance.running',
+    InstanceTerminated: 'instance.terminated',
+    InstanceFailed: 'instance.failed'
+} as const;
+export type CreateWebhookEndpointRequestEventTypesEnum = typeof CreateWebhookEndpointRequestEventTypesEnum[keyof typeof CreateWebhookEndpointRequestEventTypesEnum];
+
+
+/**
+ * Check if a given object implements the CreateWebhookEndpointRequest interface.
+ */
+export function instanceOfCreateWebhookEndpointRequest(value: object): value is CreateWebhookEndpointRequest {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if ((!('eventTypes' in (value as Record<string, any>)) && !('event_types' in (value as Record<string, any>))) || ((value as Record<string, any>)['eventTypes'] === undefined && (value as Record<string, any>)['event_types'] === undefined)) return false;
+    return true;
+}
+
+export function CreateWebhookEndpointRequestFromJSON(json: any): CreateWebhookEndpointRequest {
+    return CreateWebhookEndpointRequestFromJSONTyped(json, false);
+}
+
+export function CreateWebhookEndpointRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateWebhookEndpointRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'url': json['url'],
+        'eventTypes': json['event_types'],
+    };
+}
+
+export function CreateWebhookEndpointRequestToJSON(json: any): CreateWebhookEndpointRequest {
+    return CreateWebhookEndpointRequestToJSONTyped(json, false);
+}
+
+export function CreateWebhookEndpointRequestToJSONTyped(value?: CreateWebhookEndpointRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'url': value['url'],
+        'event_types': value['eventTypes'],
+    };
+}
+

package/src/models/CryptoDeposit.ts

@@ -0,0 +1,177 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GPU.ai Public Developer API
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@gpu.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * A stablecoin deposit. Mirrors the Go DTO field for field. Like that struct, this schema deliberately has NO payment-processor property — the processor is an implementation detail and is structurally absent from the customer contract, not merely filtered out.
+ * 
+ * @export
+ * @interface CryptoDeposit
+ */
+export interface CryptoDeposit {
+    /**
+     * 
+     * @type {string}
+     * @memberof CryptoDeposit
+     */
+    depositId: string;
+    /**
+     * Lifecycle state: created, detected, confirming, settled, screening, held_screening, credited, credited_underpaid, credited_overpaid, expired, expired_received, failed, failed_screening.
+     * 
+     * @type {string}
+     * @memberof CryptoDeposit
+     */
+    status: string;
+    /**
+     * 
+     * @type {CryptoDepositChainEnum}
+     * @memberof CryptoDeposit
+     */
+    chain: CryptoDepositChainEnum;
+    /**
+     * 
+     * @type {CryptoDepositAssetEnum}
+     * @memberof CryptoDeposit
+     */
+    asset: CryptoDepositAssetEnum;
+    /**
+     * The address to send funds to. Unique to this deposit.
+     * @type {string}
+     * @memberof CryptoDeposit
+     */
+    payAddress?: string;
+    /**
+     * The exact token amount to send, as a decimal string (never a number — the value must not round-trip through a float).
+     * 
+     * @type {string}
+     * @memberof CryptoDeposit
+     */
+    payAmount?: string;
+    /**
+     * The amount requested, in USD cents. Never the settled or credited value.
+     * @type {number}
+     * @memberof CryptoDeposit
+     */
+    amountUsdCents: number;
+    /**
+     * USD cents actually credited to the balance. Absent until credited.
+     * @type {number}
+     * @memberof CryptoDeposit
+     */
+    creditedCents?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CryptoDeposit
+     */
+    txHash?: string;
+    /**
+     * RFC3339 UTC. After this, send nothing to pay_address.
+     * @type {Date}
+     * @memberof CryptoDeposit
+     */
+    expiresAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CryptoDeposit
+     */
+    createdAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const CryptoDepositChainEnum = {
+    Ethereum: 'ethereum',
+    Base: 'base',
+    Arbitrum: 'arbitrum',
+    Polygon: 'polygon',
+    Solana: 'solana'
+} as const;
+export type CryptoDepositChainEnum = typeof CryptoDepositChainEnum[keyof typeof CryptoDepositChainEnum];
+
+/**
+ * @export
+ */
+export const CryptoDepositAssetEnum = {
+    Usdc: 'usdc',
+    Usdt: 'usdt'
+} as const;
+export type CryptoDepositAssetEnum = typeof CryptoDepositAssetEnum[keyof typeof CryptoDepositAssetEnum];
+
+
+/**
+ * Check if a given object implements the CryptoDeposit interface.
+ */
+export function instanceOfCryptoDeposit(value: object): value is CryptoDeposit {
+    if ((!('depositId' in (value as Record<string, any>)) && !('deposit_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['depositId'] === undefined && (value as Record<string, any>)['deposit_id'] === undefined)) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('chain' in value) || value['chain'] === undefined) return false;
+    if (!('asset' in value) || value['asset'] === undefined) return false;
+    if ((!('amountUsdCents' in (value as Record<string, any>)) && !('amount_usd_cents' in (value as Record<string, any>))) || ((value as Record<string, any>)['amountUsdCents'] === undefined && (value as Record<string, any>)['amount_usd_cents'] === undefined)) return false;
+    if ((!('createdAt' in (value as Record<string, any>)) && !('created_at' in (value as Record<string, any>))) || ((value as Record<string, any>)['createdAt'] === undefined && (value as Record<string, any>)['created_at'] === undefined)) return false;
+    return true;
+}
+
+export function CryptoDepositFromJSON(json: any): CryptoDeposit {
+    return CryptoDepositFromJSONTyped(json, false);
+}
+
+export function CryptoDepositFromJSONTyped(json: any, ignoreDiscriminator: boolean): CryptoDeposit {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'depositId': json['deposit_id'],
+        'status': json['status'],
+        'chain': json['chain'],
+        'asset': json['asset'],
+        'payAddress': json['pay_address'] == null ? undefined : json['pay_address'],
+        'payAmount': json['pay_amount'] == null ? undefined : json['pay_amount'],
+        'amountUsdCents': json['amount_usd_cents'],
+        'creditedCents': json['credited_cents'] == null ? undefined : json['credited_cents'],
+        'txHash': json['tx_hash'] == null ? undefined : json['tx_hash'],
+        'expiresAt': json['expires_at'] == null ? undefined : (new Date(json['expires_at'])),
+        'createdAt': (new Date(json['created_at'])),
+    };
+}
+
+export function CryptoDepositToJSON(json: any): CryptoDeposit {
+    return CryptoDepositToJSONTyped(json, false);
+}
+
+export function CryptoDepositToJSONTyped(value?: CryptoDeposit | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'deposit_id': value['depositId'],
+        'status': value['status'],
+        'chain': value['chain'],
+        'asset': value['asset'],
+        'pay_address': value['payAddress'],
+        'pay_amount': value['payAmount'],
+        'amount_usd_cents': value['amountUsdCents'],
+        'credited_cents': value['creditedCents'],
+        'tx_hash': value['txHash'],
+        'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
+        'created_at': value['createdAt'].toISOString(),
+    };
+}
+

package/src/models/Environments.ts

@@ -0,0 +1,115 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GPU.ai Public Developer API
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@gpu.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { IncludeItem } from './IncludeItem';
+import {
+    IncludeItemFromJSON,
+    IncludeItemFromJSONTyped,
+    IncludeItemToJSON,
+    IncludeItemToJSONTyped,
+} from './IncludeItem';
+import type { VMImage } from './VMImage';
+import {
+    VMImageFromJSON,
+    VMImageFromJSONTyped,
+    VMImageToJSON,
+    VMImageToJSONTyped,
+} from './VMImage';
+import type { FrameworkVersion } from './FrameworkVersion';
+import {
+    FrameworkVersionFromJSON,
+    FrameworkVersionFromJSONTyped,
+    FrameworkVersionToJSON,
+    FrameworkVersionToJSONTyped,
+} from './FrameworkVersion';
+
+/**
+ * The launch environment catalog (GET /v1/environments).
+ * @export
+ * @interface Environments
+ */
+export interface Environments {
+    /**
+     * Certified framework ids whose images are fully published — the `certified:<framework>` options.
+     * @type {Array<string>}
+     * @memberof Environments
+     */
+    frameworks: Array<string>;
+    /**
+     * The version picker roster: framework id → selectable versions (the `certified:<framework>@<version>` grammar). A framework absent here has one build per CUDA variant. `variant` is the CUDA variant a version targets — only offerings whose GPU maps to it can run it.
+     * @type {{ [key: string]: Array<FrameworkVersion>; }}
+     * @memberof Environments
+     */
+    versions: { [key: string]: Array<FrameworkVersion>; };
+    /**
+     * "What's included" software lists: framework id (roster ids plus "base") → CUDA variant ("cuda128"/"cuda124") → components.
+     * @type {{ [key: string]: { [key: string]: Array<IncludeItem>; }; }}
+     * @memberof Environments
+     */
+    includes: { [key: string]: { [key: string]: Array<IncludeItem>; }; };
+    /**
+     * The raw-VM OS catalog (the `raw_vm:<os>` grammar), keyed by os id.
+     * @type {{ [key: string]: VMImage; }}
+     * @memberof Environments
+     */
+    vmImages: { [key: string]: VMImage; };
+}
+
+/**
+ * Check if a given object implements the Environments interface.
+ */
+export function instanceOfEnvironments(value: object): value is Environments {
+    if (!('frameworks' in value) || value['frameworks'] === undefined) return false;
+    if (!('versions' in value) || value['versions'] === undefined) return false;
+    if (!('includes' in value) || value['includes'] === undefined) return false;
+    if ((!('vmImages' in (value as Record<string, any>)) && !('vm_images' in (value as Record<string, any>))) || ((value as Record<string, any>)['vmImages'] === undefined && (value as Record<string, any>)['vm_images'] === undefined)) return false;
+    return true;
+}
+
+export function EnvironmentsFromJSON(json: any): Environments {
+    return EnvironmentsFromJSONTyped(json, false);
+}
+
+export function EnvironmentsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Environments {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'frameworks': json['frameworks'],
+        'versions': json['versions'],
+        'includes': json['includes'],
+        'vmImages': (mapValues(json['vm_images'], VMImageFromJSON)),
+    };
+}
+
+export function EnvironmentsToJSON(json: any): Environments {
+    return EnvironmentsToJSONTyped(json, false);
+}
+
+export function EnvironmentsToJSONTyped(value?: Environments | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'frameworks': value['frameworks'],
+        'versions': value['versions'],
+        'includes': value['includes'],
+        'vm_images': (mapValues(value['vmImages'], VMImageToJSON)),
+    };
+}
+