@gpuai/sdk 0.5.4 → 0.5.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (202) hide show
  1. package/.openapi-generator/FILES +56 -0
  2. package/README.md +50 -2
  3. package/dist/apis/EndpointsApi.d.ts +150 -0
  4. package/dist/apis/EndpointsApi.js +379 -0
  5. package/dist/apis/InstancesApi.d.ts +15 -0
  6. package/dist/apis/InstancesApi.js +45 -0
  7. package/dist/apis/JobsApi.d.ts +172 -0
  8. package/dist/apis/JobsApi.js +444 -0
  9. package/dist/apis/OperationsApi.d.ts +17 -0
  10. package/dist/apis/OperationsApi.js +48 -0
  11. package/dist/apis/SecretsApi.d.ts +123 -0
  12. package/dist/apis/SecretsApi.js +328 -0
  13. package/dist/apis/index.d.ts +3 -0
  14. package/dist/apis/index.js +3 -0
  15. package/dist/esm/apis/EndpointsApi.d.ts +150 -0
  16. package/dist/esm/apis/EndpointsApi.js +375 -0
  17. package/dist/esm/apis/InstancesApi.d.ts +15 -0
  18. package/dist/esm/apis/InstancesApi.js +45 -0
  19. package/dist/esm/apis/JobsApi.d.ts +172 -0
  20. package/dist/esm/apis/JobsApi.js +440 -0
  21. package/dist/esm/apis/OperationsApi.d.ts +17 -0
  22. package/dist/esm/apis/OperationsApi.js +48 -0
  23. package/dist/esm/apis/SecretsApi.d.ts +123 -0
  24. package/dist/esm/apis/SecretsApi.js +324 -0
  25. package/dist/esm/apis/index.d.ts +3 -0
  26. package/dist/esm/apis/index.js +3 -0
  27. package/dist/esm/models/DedicatedIPOffer.d.ts +98 -0
  28. package/dist/esm/models/DedicatedIPOffer.js +87 -0
  29. package/dist/esm/models/Endpoint.d.ts +147 -0
  30. package/dist/esm/models/Endpoint.js +121 -0
  31. package/dist/esm/models/EndpointCreate.d.ts +80 -0
  32. package/dist/esm/models/EndpointCreate.js +63 -0
  33. package/dist/esm/models/EndpointList.d.ts +33 -0
  34. package/dist/esm/models/EndpointList.js +44 -0
  35. package/dist/esm/models/EndpointMachine.d.ts +90 -0
  36. package/dist/esm/models/EndpointMachine.js +84 -0
  37. package/dist/esm/models/EndpointReplicaCounts.d.ts +38 -0
  38. package/dist/esm/models/EndpointReplicaCounts.js +47 -0
  39. package/dist/esm/models/Job.d.ts +352 -0
  40. package/dist/esm/models/Job.js +254 -0
  41. package/dist/esm/models/JobAttempt.d.ts +176 -0
  42. package/dist/esm/models/JobAttempt.js +147 -0
  43. package/dist/esm/models/JobCreate.d.ts +153 -0
  44. package/dist/esm/models/JobCreate.js +84 -0
  45. package/dist/esm/models/JobGpuTypes.d.ts +39 -0
  46. package/dist/esm/models/JobGpuTypes.js +48 -0
  47. package/dist/esm/models/JobGpuTypesDataInner.d.ts +58 -0
  48. package/dist/esm/models/JobGpuTypesDataInner.js +59 -0
  49. package/dist/esm/models/JobLogChunk.d.ts +50 -0
  50. package/dist/esm/models/JobLogChunk.js +55 -0
  51. package/dist/esm/models/JobLogs.d.ts +39 -0
  52. package/dist/esm/models/JobLogs.js +48 -0
  53. package/dist/esm/models/JobPage.d.ts +39 -0
  54. package/dist/esm/models/JobPage.js +48 -0
  55. package/dist/esm/models/JobSharingHint.d.ts +46 -0
  56. package/dist/esm/models/JobSharingHint.js +51 -0
  57. package/dist/esm/models/JobTelemetry.d.ts +51 -0
  58. package/dist/esm/models/JobTelemetry.js +56 -0
  59. package/dist/esm/models/JobTelemetryPoint.d.ts +56 -0
  60. package/dist/esm/models/JobTelemetryPoint.js +59 -0
  61. package/dist/esm/models/JobTrial.d.ts +79 -0
  62. package/dist/esm/models/JobTrial.js +73 -0
  63. package/dist/esm/models/Operation.d.ts +6 -0
  64. package/dist/esm/models/Operation.js +2 -0
  65. package/dist/esm/models/Secret.d.ts +62 -0
  66. package/dist/esm/models/Secret.js +63 -0
  67. package/dist/esm/models/SecretCreate.d.ts +44 -0
  68. package/dist/esm/models/SecretCreate.js +49 -0
  69. package/dist/esm/models/SecretImportItem.d.ts +38 -0
  70. package/dist/esm/models/SecretImportItem.js +47 -0
  71. package/dist/esm/models/SecretImportRequest.d.ts +39 -0
  72. package/dist/esm/models/SecretImportRequest.js +46 -0
  73. package/dist/esm/models/SecretImportResult.d.ts +44 -0
  74. package/dist/esm/models/SecretImportResult.js +51 -0
  75. package/dist/esm/models/SecretList.d.ts +33 -0
  76. package/dist/esm/models/SecretList.js +44 -0
  77. package/dist/esm/models/SecretPut.d.ts +38 -0
  78. package/dist/esm/models/SecretPut.js +45 -0
  79. package/dist/esm/models/index.d.ts +25 -0
  80. package/dist/esm/models/index.js +25 -0
  81. package/dist/esm/runtime.js +1 -1
  82. package/dist/models/DedicatedIPOffer.d.ts +98 -0
  83. package/dist/models/DedicatedIPOffer.js +94 -0
  84. package/dist/models/Endpoint.d.ts +147 -0
  85. package/dist/models/Endpoint.js +129 -0
  86. package/dist/models/EndpointCreate.d.ts +80 -0
  87. package/dist/models/EndpointCreate.js +70 -0
  88. package/dist/models/EndpointList.d.ts +33 -0
  89. package/dist/models/EndpointList.js +51 -0
  90. package/dist/models/EndpointMachine.d.ts +90 -0
  91. package/dist/models/EndpointMachine.js +92 -0
  92. package/dist/models/EndpointReplicaCounts.d.ts +38 -0
  93. package/dist/models/EndpointReplicaCounts.js +54 -0
  94. package/dist/models/Job.d.ts +352 -0
  95. package/dist/models/Job.js +262 -0
  96. package/dist/models/JobAttempt.d.ts +176 -0
  97. package/dist/models/JobAttempt.js +155 -0
  98. package/dist/models/JobCreate.d.ts +153 -0
  99. package/dist/models/JobCreate.js +92 -0
  100. package/dist/models/JobGpuTypes.d.ts +39 -0
  101. package/dist/models/JobGpuTypes.js +55 -0
  102. package/dist/models/JobGpuTypesDataInner.d.ts +58 -0
  103. package/dist/models/JobGpuTypesDataInner.js +66 -0
  104. package/dist/models/JobLogChunk.d.ts +50 -0
  105. package/dist/models/JobLogChunk.js +62 -0
  106. package/dist/models/JobLogs.d.ts +39 -0
  107. package/dist/models/JobLogs.js +55 -0
  108. package/dist/models/JobPage.d.ts +39 -0
  109. package/dist/models/JobPage.js +55 -0
  110. package/dist/models/JobSharingHint.d.ts +46 -0
  111. package/dist/models/JobSharingHint.js +58 -0
  112. package/dist/models/JobTelemetry.d.ts +51 -0
  113. package/dist/models/JobTelemetry.js +63 -0
  114. package/dist/models/JobTelemetryPoint.d.ts +56 -0
  115. package/dist/models/JobTelemetryPoint.js +66 -0
  116. package/dist/models/JobTrial.d.ts +79 -0
  117. package/dist/models/JobTrial.js +81 -0
  118. package/dist/models/Operation.d.ts +6 -0
  119. package/dist/models/Operation.js +2 -0
  120. package/dist/models/Secret.d.ts +62 -0
  121. package/dist/models/Secret.js +70 -0
  122. package/dist/models/SecretCreate.d.ts +44 -0
  123. package/dist/models/SecretCreate.js +56 -0
  124. package/dist/models/SecretImportItem.d.ts +38 -0
  125. package/dist/models/SecretImportItem.js +54 -0
  126. package/dist/models/SecretImportRequest.d.ts +39 -0
  127. package/dist/models/SecretImportRequest.js +53 -0
  128. package/dist/models/SecretImportResult.d.ts +44 -0
  129. package/dist/models/SecretImportResult.js +58 -0
  130. package/dist/models/SecretList.d.ts +33 -0
  131. package/dist/models/SecretList.js +51 -0
  132. package/dist/models/SecretPut.d.ts +38 -0
  133. package/dist/models/SecretPut.js +52 -0
  134. package/dist/models/index.d.ts +25 -0
  135. package/dist/models/index.js +25 -0
  136. package/dist/runtime.js +1 -1
  137. package/docs/DedicatedIPOffer.md +56 -0
  138. package/docs/Endpoint.md +68 -0
  139. package/docs/EndpointCreate.md +50 -0
  140. package/docs/EndpointList.md +34 -0
  141. package/docs/EndpointMachine.md +50 -0
  142. package/docs/EndpointReplicaCounts.md +36 -0
  143. package/docs/EndpointsApi.md +544 -0
  144. package/docs/InstancesApi.md +68 -1
  145. package/docs/Job.md +125 -0
  146. package/docs/JobAttempt.md +69 -0
  147. package/docs/JobCreate.md +66 -0
  148. package/docs/JobGpuTypes.md +36 -0
  149. package/docs/JobGpuTypesDataInner.md +42 -0
  150. package/docs/JobLogChunk.md +40 -0
  151. package/docs/JobLogs.md +36 -0
  152. package/docs/JobPage.md +36 -0
  153. package/docs/JobSharingHint.md +39 -0
  154. package/docs/JobTelemetry.md +40 -0
  155. package/docs/JobTelemetryPoint.md +42 -0
  156. package/docs/JobTrial.md +46 -0
  157. package/docs/JobsApi.md +609 -0
  158. package/docs/Operation.md +2 -0
  159. package/docs/OperationsApi.md +76 -0
  160. package/docs/Secret.md +45 -0
  161. package/docs/SecretCreate.md +38 -0
  162. package/docs/SecretImportItem.md +36 -0
  163. package/docs/SecretImportRequest.md +36 -0
  164. package/docs/SecretImportResult.md +38 -0
  165. package/docs/SecretList.md +34 -0
  166. package/docs/SecretPut.md +36 -0
  167. package/docs/SecretsApi.md +450 -0
  168. package/package.json +1 -1
  169. package/src/apis/EndpointsApi.ts +481 -0
  170. package/src/apis/InstancesApi.ts +52 -0
  171. package/src/apis/JobsApi.ts +551 -0
  172. package/src/apis/OperationsApi.ts +59 -0
  173. package/src/apis/SecretsApi.ts +413 -0
  174. package/src/apis/index.ts +3 -0
  175. package/src/models/DedicatedIPOffer.ts +165 -0
  176. package/src/models/Endpoint.ts +247 -0
  177. package/src/models/EndpointCreate.ts +132 -0
  178. package/src/models/EndpointList.ts +74 -0
  179. package/src/models/EndpointMachine.ts +151 -0
  180. package/src/models/EndpointReplicaCounts.ts +75 -0
  181. package/src/models/Job.ts +538 -0
  182. package/src/models/JobAttempt.ts +267 -0
  183. package/src/models/JobCreate.ts +221 -0
  184. package/src/models/JobGpuTypes.ts +83 -0
  185. package/src/models/JobGpuTypesDataInner.ts +104 -0
  186. package/src/models/JobLogChunk.ts +93 -0
  187. package/src/models/JobLogs.ts +83 -0
  188. package/src/models/JobPage.ts +83 -0
  189. package/src/models/JobSharingHint.ts +86 -0
  190. package/src/models/JobTelemetry.ts +101 -0
  191. package/src/models/JobTelemetryPoint.ts +102 -0
  192. package/src/models/JobTrial.ts +132 -0
  193. package/src/models/Operation.ts +8 -0
  194. package/src/models/Secret.ts +111 -0
  195. package/src/models/SecretCreate.ts +83 -0
  196. package/src/models/SecretImportItem.ts +75 -0
  197. package/src/models/SecretImportRequest.ts +82 -0
  198. package/src/models/SecretImportResult.ts +84 -0
  199. package/src/models/SecretList.ts +74 -0
  200. package/src/models/SecretPut.ts +74 -0
  201. package/src/models/index.ts +25 -0
  202. package/src/runtime.ts +1 -1
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.gpu.ai/v1*
6
6
  |------------- | ------------- | -------------|
7
7
  | [**createInstance**](InstancesApi.md#createinstanceoperation) | **POST** /instances | Create an instance (async — returns 202 + Operation-Id header) |
8
8
  | [**deleteInstance**](InstancesApi.md#deleteinstance) | **DELETE** /instances/{id} | Terminate an instance (idempotent) |
9
+ | [**getDedicatedIpOffer**](InstancesApi.md#getdedicatedipoffer) | **GET** /dedicated-ip | Get the dedicated public IP add-on offer |
9
10
  | [**getInstance**](InstancesApi.md#getinstance) | **GET** /instances/{id} | Get an instance |
10
11
  | [**getInstanceGpuSuggestion**](InstancesApi.md#getinstancegpusuggestion) | **GET** /instances/{id}/gpu-suggestion | Suggest a lower-priced GPU for an instance |
11
12
  | [**listInstances**](InstancesApi.md#listinstances) | **GET** /instances | List instances |
@@ -82,7 +83,7 @@ example().catch(console.error);
82
83
  ### HTTP response details
83
84
  | Status code | Description | Response headers |
84
85
  |-------------|-------------|------------------|
85
- | **202** | Accepted; long-running operation | * Operation-Id - Use GET /operations/{id} to poll <br> * GPUAI-Hint - Advisory only, and absent on most launches. Sent when the request is a one-off batch run (a custom image with a command and auto_terminate_hours) to point at Jobs (POST /jobs), which start a machine for the work and shut it down a few minutes after it ends. It never changes the launch. <br> * GPUAI-Balance-Warning - <br> |
86
+ | **202** | Accepted; long-running operation | * Operation-Id - Use GET /operations/{id} to poll <br> * GPUAI-Hint - Advisory only, and absent on most launches. Sent to point at Jobs (POST /jobs), which start a machine for the work and shut it down a few minutes after it ends, when the request is a one-off batch run (a custom image with a command and auto_terminate_hours) or the organization launched many instances in the last 24 hours that each ran for less than 15 minutes. The same text is in the response body\&#39;s hint field. It never changes the launch. <br> * GPUAI-Balance-Warning - <br> |
86
87
  | **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
87
88
  | **0** | Error response (RFC 7807) | - |
88
89
 
@@ -167,6 +168,72 @@ example().catch(console.error);
167
168
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
168
169
 
169
170
 
171
+ ## getDedicatedIpOffer
172
+
173
+ > DedicatedIPOffer getDedicatedIpOffer()
174
+
175
+ Get the dedicated public IP add-on offer
176
+
177
+ Describes the dedicated public IPv4 add-on for instances and the caller\&#39;s usage of it. A dedicated IP is a GPU.ai-owned public address (never the supplier\&#39;s) that forwards the chosen inbound TCP ports, raw and without TLS termination, to the same ports on the instance\&#39;s loopback. Request one at launch with the &#x60;dedicated_ip&#x60; field on POST /instances. The response carries the hourly fee charged while the address is attached, the transfer price per GB (counted in both directions), the transfer cap per attachment after which forwarding is suspended, the ports a launch may forward, the organization\&#39;s limit and how many it holds, how many addresses are free right now, and the acceptable use policy. Requires the &#x60;instances:read&#x60; scope. Returns 404 when the add-on is not enabled for this deployment.
178
+
179
+ ### Example
180
+
181
+ ```ts
182
+ import {
183
+ Configuration,
184
+ InstancesApi,
185
+ } from '@gpuai/sdk';
186
+ import type { GetDedicatedIpOfferRequest } from '@gpuai/sdk';
187
+
188
+ async function example() {
189
+ console.log("🚀 Testing @gpuai/sdk SDK...");
190
+ const config = new Configuration({
191
+ // Configure HTTP bearer authorization: bearerAuth
192
+ accessToken: "YOUR BEARER TOKEN",
193
+ });
194
+ const api = new InstancesApi(config);
195
+
196
+ try {
197
+ const data = await api.getDedicatedIpOffer();
198
+ console.log(data);
199
+ } catch (error) {
200
+ console.error(error);
201
+ }
202
+ }
203
+
204
+ // Run the test
205
+ example().catch(console.error);
206
+ ```
207
+
208
+ ### Parameters
209
+
210
+ This endpoint does not need any parameter.
211
+
212
+ ### Return type
213
+
214
+ [**DedicatedIPOffer**](DedicatedIPOffer.md)
215
+
216
+ ### Authorization
217
+
218
+ [bearerAuth](../README.md#bearerAuth)
219
+
220
+ ### HTTP request headers
221
+
222
+ - **Content-Type**: Not defined
223
+ - **Accept**: `application/json`, `application/problem+json`
224
+
225
+
226
+ ### HTTP response details
227
+ | Status code | Description | Response headers |
228
+ |-------------|-------------|------------------|
229
+ | **200** | OK | - |
230
+ | **404** | The dedicated IP add-on is not enabled for this deployment. | - |
231
+ | **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
232
+ | **0** | Error response (RFC 7807) | - |
233
+
234
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
235
+
236
+
170
237
  ## getInstance
171
238
 
172
239
  > Instance getInstance(id, include)
package/docs/Job.md ADDED
@@ -0,0 +1,125 @@
1
+
2
+ # Job
3
+
4
+ A batch job. It names no machine: the machines a job runs on are instances of your organization and appear in the instance list.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `id` | string
11
+ `name` | string
12
+ `image` | string
13
+ `command` | Array&lt;string&gt;
14
+ `envNames` | Array&lt;string&gt;
15
+ `secrets` | Array&lt;string&gt;
16
+ `gpuType` | string
17
+ `minVramGb` | number
18
+ `memoryHintMb` | number
19
+ `computeHintPct` | number
20
+ `timeoutSeconds` | number
21
+ `maxWaitSeconds` | number
22
+ `allowSharing` | boolean
23
+ `allowRestart` | boolean
24
+ `isolation` | string
25
+ `migProfile` | string
26
+ `checkpointPath` | string
27
+ `maxRetries` | number
28
+ `maxPricePerHour` | number
29
+ `status` | string
30
+ `statusReason` | string
31
+ `cancelRequested` | boolean
32
+ `attempt` | number
33
+ `retries` | number
34
+ `evictions` | number
35
+ `oomExits` | number
36
+ `reservationMb` | number
37
+ `wholeGpu` | boolean
38
+ `predictedMb` | number
39
+ `predictionSource` | string
40
+ `predictedComputePct` | number
41
+ `computePredictionSource` | string
42
+ `peakMemoryMb` | number
43
+ `gpuMemoryTotalMb` | number
44
+ `utilMeanPct` | number
45
+ `busyPct` | number
46
+ `memorySource` | string
47
+ `sharingMode` | string
48
+ `gpuSeconds` | number
49
+ `attributedCostUsd` | number
50
+ `exitCode` | number
51
+ `createdAt` | Date
52
+ `startedAt` | Date
53
+ `finishedAt` | Date
54
+ `sharingHint` | [JobSharingHint](JobSharingHint.md)
55
+ `attempts` | [Array&lt;JobAttempt&gt;](JobAttempt.md)
56
+
57
+ ## Example
58
+
59
+ ```typescript
60
+ import type { Job } from '@gpuai/sdk'
61
+
62
+ // TODO: Update the object below with actual values
63
+ const example = {
64
+ "id": null,
65
+ "name": null,
66
+ "image": null,
67
+ "command": null,
68
+ "envNames": null,
69
+ "secrets": null,
70
+ "gpuType": null,
71
+ "minVramGb": null,
72
+ "memoryHintMb": null,
73
+ "computeHintPct": null,
74
+ "timeoutSeconds": null,
75
+ "maxWaitSeconds": null,
76
+ "allowSharing": null,
77
+ "allowRestart": null,
78
+ "isolation": null,
79
+ "migProfile": null,
80
+ "checkpointPath": null,
81
+ "maxRetries": null,
82
+ "maxPricePerHour": null,
83
+ "status": null,
84
+ "statusReason": null,
85
+ "cancelRequested": null,
86
+ "attempt": null,
87
+ "retries": null,
88
+ "evictions": null,
89
+ "oomExits": null,
90
+ "reservationMb": null,
91
+ "wholeGpu": null,
92
+ "predictedMb": null,
93
+ "predictionSource": null,
94
+ "predictedComputePct": null,
95
+ "computePredictionSource": null,
96
+ "peakMemoryMb": null,
97
+ "gpuMemoryTotalMb": null,
98
+ "utilMeanPct": null,
99
+ "busyPct": null,
100
+ "memorySource": null,
101
+ "sharingMode": null,
102
+ "gpuSeconds": null,
103
+ "attributedCostUsd": null,
104
+ "exitCode": null,
105
+ "createdAt": null,
106
+ "startedAt": null,
107
+ "finishedAt": null,
108
+ "sharingHint": null,
109
+ "attempts": null,
110
+ } satisfies Job
111
+
112
+ console.log(example)
113
+
114
+ // Convert the instance to a JSON string
115
+ const exampleJSON: string = JSON.stringify(example)
116
+ console.log(exampleJSON)
117
+
118
+ // Parse the JSON string back to an object
119
+ const exampleParsed = JSON.parse(exampleJSON) as Job
120
+ console.log(exampleParsed)
121
+ ```
122
+
123
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
124
+
125
+
@@ -0,0 +1,69 @@
1
+
2
+ # JobAttempt
3
+
4
+ One run of a job.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `attempt` | number
11
+ `reservationMb` | number
12
+ `wholeGpu` | boolean
13
+ `predictionSource` | string
14
+ `outcome` | string
15
+ `reason` | string
16
+ `exitCode` | number
17
+ `peakMemoryMb` | number
18
+ `predictedComputePct` | number
19
+ `utilMeanPct` | number
20
+ `busyPct` | number
21
+ `computeSource` | string
22
+ `memorySource` | string
23
+ `sharingMode` | string
24
+ `migProfile` | string
25
+ `resumed` | boolean
26
+ `startedAt` | Date
27
+ `endedAt` | Date
28
+
29
+ ## Example
30
+
31
+ ```typescript
32
+ import type { JobAttempt } from '@gpuai/sdk'
33
+
34
+ // TODO: Update the object below with actual values
35
+ const example = {
36
+ "attempt": null,
37
+ "reservationMb": null,
38
+ "wholeGpu": null,
39
+ "predictionSource": null,
40
+ "outcome": null,
41
+ "reason": null,
42
+ "exitCode": null,
43
+ "peakMemoryMb": null,
44
+ "predictedComputePct": null,
45
+ "utilMeanPct": null,
46
+ "busyPct": null,
47
+ "computeSource": null,
48
+ "memorySource": null,
49
+ "sharingMode": null,
50
+ "migProfile": null,
51
+ "resumed": null,
52
+ "startedAt": null,
53
+ "endedAt": null,
54
+ } satisfies JobAttempt
55
+
56
+ console.log(example)
57
+
58
+ // Convert the instance to a JSON string
59
+ const exampleJSON: string = JSON.stringify(example)
60
+ console.log(exampleJSON)
61
+
62
+ // Parse the JSON string back to an object
63
+ const exampleParsed = JSON.parse(exampleJSON) as JobAttempt
64
+ console.log(exampleParsed)
65
+ ```
66
+
67
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
68
+
69
+
@@ -0,0 +1,66 @@
1
+
2
+ # JobCreate
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `image` | string
11
+ `command` | Array&lt;string&gt;
12
+ `env` | { [key: string]: string; }
13
+ `gpuType` | string
14
+ `minVramGb` | number
15
+ `memoryHintMb` | number
16
+ `computeHintPct` | number
17
+ `timeoutSeconds` | number
18
+ `maxWaitSeconds` | number
19
+ `allowSharing` | boolean
20
+ `allowRestart` | boolean
21
+ `isolation` | string
22
+ `checkpointPath` | string
23
+ `maxRetries` | number
24
+ `maxPricePerHour` | number
25
+ `secrets` | Array&lt;string&gt;
26
+
27
+ ## Example
28
+
29
+ ```typescript
30
+ import type { JobCreate } from '@gpuai/sdk'
31
+
32
+ // TODO: Update the object below with actual values
33
+ const example = {
34
+ "name": null,
35
+ "image": null,
36
+ "command": null,
37
+ "env": null,
38
+ "gpuType": null,
39
+ "minVramGb": null,
40
+ "memoryHintMb": null,
41
+ "computeHintPct": null,
42
+ "timeoutSeconds": null,
43
+ "maxWaitSeconds": null,
44
+ "allowSharing": null,
45
+ "allowRestart": null,
46
+ "isolation": null,
47
+ "checkpointPath": null,
48
+ "maxRetries": null,
49
+ "maxPricePerHour": null,
50
+ "secrets": null,
51
+ } satisfies JobCreate
52
+
53
+ console.log(example)
54
+
55
+ // Convert the instance to a JSON string
56
+ const exampleJSON: string = JSON.stringify(example)
57
+ console.log(exampleJSON)
58
+
59
+ // Parse the JSON string back to an object
60
+ const exampleParsed = JSON.parse(exampleJSON) as JobCreate
61
+ console.log(exampleParsed)
62
+ ```
63
+
64
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
65
+
66
+
@@ -0,0 +1,36 @@
1
+
2
+ # JobGpuTypes
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array&lt;JobGpuTypesDataInner&gt;](JobGpuTypesDataInner.md)
10
+ `complete` | boolean
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { JobGpuTypes } from '@gpuai/sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "data": null,
20
+ "complete": null,
21
+ } satisfies JobGpuTypes
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as JobGpuTypes
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -0,0 +1,42 @@
1
+
2
+ # JobGpuTypesDataInner
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `gpuType` | string
10
+ `vramGb` | number
11
+ `availableNow` | boolean
12
+ `pricePerGpuHour` | number
13
+ `lastSeenAt` | Date
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { JobGpuTypesDataInner } from '@gpuai/sdk'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "gpuType": null,
23
+ "vramGb": null,
24
+ "availableNow": null,
25
+ "pricePerGpuHour": null,
26
+ "lastSeenAt": null,
27
+ } satisfies JobGpuTypesDataInner
28
+
29
+ console.log(example)
30
+
31
+ // Convert the instance to a JSON string
32
+ const exampleJSON: string = JSON.stringify(example)
33
+ console.log(exampleJSON)
34
+
35
+ // Parse the JSON string back to an object
36
+ const exampleParsed = JSON.parse(exampleJSON) as JobGpuTypesDataInner
37
+ console.log(exampleParsed)
38
+ ```
39
+
40
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
+
42
+
@@ -0,0 +1,40 @@
1
+
2
+ # JobLogChunk
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `attempt` | number
11
+ `text` | string
12
+ `createdAt` | Date
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { JobLogChunk } from '@gpuai/sdk'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "id": null,
22
+ "attempt": null,
23
+ "text": null,
24
+ "createdAt": null,
25
+ } satisfies JobLogChunk
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as JobLogChunk
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+
@@ -0,0 +1,36 @@
1
+
2
+ # JobLogs
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array&lt;JobLogChunk&gt;](JobLogChunk.md)
10
+ `nextAfter` | number
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { JobLogs } from '@gpuai/sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "data": null,
20
+ "nextAfter": null,
21
+ } satisfies JobLogs
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as JobLogs
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -0,0 +1,36 @@
1
+
2
+ # JobPage
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array&lt;Job&gt;](Job.md)
10
+ `nextCursor` | string
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { JobPage } from '@gpuai/sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "data": null,
20
+ "nextCursor": null,
21
+ } satisfies JobPage
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as JobPage
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -0,0 +1,39 @@
1
+
2
+ # JobSharingHint
3
+
4
+ Advisory only, and present only when it applies. A job carries it when it succeeded with a whole GPU it did not allow to be shared, ran at least a minute with no out-of-memory exit or eviction, and its peak GPU memory, measured from per-process accounting (`memory_source` `process`), was at most half of the GPU\'s memory. Sharing stays opt-in; the hint never changes how a job is placed.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `message` | string
11
+ `peakMemoryMb` | number
12
+ `gpuMemoryTotalMb` | number
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { JobSharingHint } from '@gpuai/sdk'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "message": null,
22
+ "peakMemoryMb": null,
23
+ "gpuMemoryTotalMb": null,
24
+ } satisfies JobSharingHint
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as JobSharingHint
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -0,0 +1,40 @@
1
+
2
+ # JobTelemetry
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `peakMemoryMb` | number
10
+ `reservationMb` | number
11
+ `gpuMemoryTotalMb` | number
12
+ `points` | [Array&lt;JobTelemetryPoint&gt;](JobTelemetryPoint.md)
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { JobTelemetry } from '@gpuai/sdk'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "peakMemoryMb": null,
22
+ "reservationMb": null,
23
+ "gpuMemoryTotalMb": null,
24
+ "points": null,
25
+ } satisfies JobTelemetry
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as JobTelemetry
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+
@@ -0,0 +1,42 @@
1
+
2
+ # JobTelemetryPoint
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `ts` | Date
10
+ `attempt` | number
11
+ `memoryMb` | number
12
+ `gpuMemoryMb` | number
13
+ `gpuUtilPct` | number
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { JobTelemetryPoint } from '@gpuai/sdk'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "ts": null,
23
+ "attempt": null,
24
+ "memoryMb": null,
25
+ "gpuMemoryMb": null,
26
+ "gpuUtilPct": null,
27
+ } satisfies JobTelemetryPoint
28
+
29
+ console.log(example)
30
+
31
+ // Convert the instance to a JSON string
32
+ const exampleJSON: string = JSON.stringify(example)
33
+ console.log(exampleJSON)
34
+
35
+ // Parse the JSON string back to an object
36
+ const exampleParsed = JSON.parse(exampleJSON) as JobTelemetryPoint
37
+ console.log(exampleParsed)
38
+ ```
39
+
40
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
+
42
+