@gpuai/sdk 0.5.3 → 0.5.5

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 (218) hide show
  1. package/.openapi-generator/FILES +56 -0
  2. package/README.md +50 -2
  3. package/dist/apis/BillingApi.d.ts +2 -2
  4. package/dist/apis/BillingApi.js +2 -2
  5. package/dist/apis/EndpointsApi.d.ts +150 -0
  6. package/dist/apis/EndpointsApi.js +379 -0
  7. package/dist/apis/InstancesApi.d.ts +15 -0
  8. package/dist/apis/InstancesApi.js +45 -0
  9. package/dist/apis/JobsApi.d.ts +172 -0
  10. package/dist/apis/JobsApi.js +444 -0
  11. package/dist/apis/OperationsApi.d.ts +17 -0
  12. package/dist/apis/OperationsApi.js +48 -0
  13. package/dist/apis/SecretsApi.d.ts +123 -0
  14. package/dist/apis/SecretsApi.js +328 -0
  15. package/dist/apis/index.d.ts +3 -0
  16. package/dist/apis/index.js +3 -0
  17. package/dist/esm/apis/BillingApi.d.ts +2 -2
  18. package/dist/esm/apis/BillingApi.js +2 -2
  19. package/dist/esm/apis/EndpointsApi.d.ts +150 -0
  20. package/dist/esm/apis/EndpointsApi.js +375 -0
  21. package/dist/esm/apis/InstancesApi.d.ts +15 -0
  22. package/dist/esm/apis/InstancesApi.js +45 -0
  23. package/dist/esm/apis/JobsApi.d.ts +172 -0
  24. package/dist/esm/apis/JobsApi.js +440 -0
  25. package/dist/esm/apis/OperationsApi.d.ts +17 -0
  26. package/dist/esm/apis/OperationsApi.js +48 -0
  27. package/dist/esm/apis/SecretsApi.d.ts +123 -0
  28. package/dist/esm/apis/SecretsApi.js +324 -0
  29. package/dist/esm/apis/index.d.ts +3 -0
  30. package/dist/esm/apis/index.js +3 -0
  31. package/dist/esm/models/Balance.d.ts +6 -0
  32. package/dist/esm/models/Balance.js +2 -0
  33. package/dist/esm/models/CreateWebhookEndpointRequest.d.ts +3 -0
  34. package/dist/esm/models/CreateWebhookEndpointRequest.js +4 -1
  35. package/dist/esm/models/DedicatedIPOffer.d.ts +98 -0
  36. package/dist/esm/models/DedicatedIPOffer.js +87 -0
  37. package/dist/esm/models/Endpoint.d.ts +147 -0
  38. package/dist/esm/models/Endpoint.js +121 -0
  39. package/dist/esm/models/EndpointCreate.d.ts +80 -0
  40. package/dist/esm/models/EndpointCreate.js +63 -0
  41. package/dist/esm/models/EndpointList.d.ts +33 -0
  42. package/dist/esm/models/EndpointList.js +44 -0
  43. package/dist/esm/models/EndpointMachine.d.ts +90 -0
  44. package/dist/esm/models/EndpointMachine.js +84 -0
  45. package/dist/esm/models/EndpointReplicaCounts.d.ts +38 -0
  46. package/dist/esm/models/EndpointReplicaCounts.js +47 -0
  47. package/dist/esm/models/Job.d.ts +352 -0
  48. package/dist/esm/models/Job.js +254 -0
  49. package/dist/esm/models/JobAttempt.d.ts +176 -0
  50. package/dist/esm/models/JobAttempt.js +147 -0
  51. package/dist/esm/models/JobCreate.d.ts +153 -0
  52. package/dist/esm/models/JobCreate.js +84 -0
  53. package/dist/esm/models/JobGpuTypes.d.ts +39 -0
  54. package/dist/esm/models/JobGpuTypes.js +48 -0
  55. package/dist/esm/models/JobGpuTypesDataInner.d.ts +58 -0
  56. package/dist/esm/models/JobGpuTypesDataInner.js +59 -0
  57. package/dist/esm/models/JobLogChunk.d.ts +50 -0
  58. package/dist/esm/models/JobLogChunk.js +55 -0
  59. package/dist/esm/models/JobLogs.d.ts +39 -0
  60. package/dist/esm/models/JobLogs.js +48 -0
  61. package/dist/esm/models/JobPage.d.ts +39 -0
  62. package/dist/esm/models/JobPage.js +48 -0
  63. package/dist/esm/models/JobSharingHint.d.ts +46 -0
  64. package/dist/esm/models/JobSharingHint.js +51 -0
  65. package/dist/esm/models/JobTelemetry.d.ts +51 -0
  66. package/dist/esm/models/JobTelemetry.js +56 -0
  67. package/dist/esm/models/JobTelemetryPoint.d.ts +56 -0
  68. package/dist/esm/models/JobTelemetryPoint.js +59 -0
  69. package/dist/esm/models/JobTrial.d.ts +79 -0
  70. package/dist/esm/models/JobTrial.js +73 -0
  71. package/dist/esm/models/Secret.d.ts +62 -0
  72. package/dist/esm/models/Secret.js +63 -0
  73. package/dist/esm/models/SecretCreate.d.ts +44 -0
  74. package/dist/esm/models/SecretCreate.js +49 -0
  75. package/dist/esm/models/SecretImportItem.d.ts +38 -0
  76. package/dist/esm/models/SecretImportItem.js +47 -0
  77. package/dist/esm/models/SecretImportRequest.d.ts +39 -0
  78. package/dist/esm/models/SecretImportRequest.js +46 -0
  79. package/dist/esm/models/SecretImportResult.d.ts +44 -0
  80. package/dist/esm/models/SecretImportResult.js +51 -0
  81. package/dist/esm/models/SecretList.d.ts +33 -0
  82. package/dist/esm/models/SecretList.js +44 -0
  83. package/dist/esm/models/SecretPut.d.ts +38 -0
  84. package/dist/esm/models/SecretPut.js +45 -0
  85. package/dist/esm/models/WebhookEndpoint.d.ts +3 -0
  86. package/dist/esm/models/WebhookEndpoint.js +4 -1
  87. package/dist/esm/models/index.d.ts +25 -0
  88. package/dist/esm/models/index.js +25 -0
  89. package/dist/esm/runtime.js +1 -1
  90. package/dist/models/Balance.d.ts +6 -0
  91. package/dist/models/Balance.js +2 -0
  92. package/dist/models/CreateWebhookEndpointRequest.d.ts +3 -0
  93. package/dist/models/CreateWebhookEndpointRequest.js +4 -1
  94. package/dist/models/DedicatedIPOffer.d.ts +98 -0
  95. package/dist/models/DedicatedIPOffer.js +94 -0
  96. package/dist/models/Endpoint.d.ts +147 -0
  97. package/dist/models/Endpoint.js +129 -0
  98. package/dist/models/EndpointCreate.d.ts +80 -0
  99. package/dist/models/EndpointCreate.js +70 -0
  100. package/dist/models/EndpointList.d.ts +33 -0
  101. package/dist/models/EndpointList.js +51 -0
  102. package/dist/models/EndpointMachine.d.ts +90 -0
  103. package/dist/models/EndpointMachine.js +92 -0
  104. package/dist/models/EndpointReplicaCounts.d.ts +38 -0
  105. package/dist/models/EndpointReplicaCounts.js +54 -0
  106. package/dist/models/Job.d.ts +352 -0
  107. package/dist/models/Job.js +262 -0
  108. package/dist/models/JobAttempt.d.ts +176 -0
  109. package/dist/models/JobAttempt.js +155 -0
  110. package/dist/models/JobCreate.d.ts +153 -0
  111. package/dist/models/JobCreate.js +92 -0
  112. package/dist/models/JobGpuTypes.d.ts +39 -0
  113. package/dist/models/JobGpuTypes.js +55 -0
  114. package/dist/models/JobGpuTypesDataInner.d.ts +58 -0
  115. package/dist/models/JobGpuTypesDataInner.js +66 -0
  116. package/dist/models/JobLogChunk.d.ts +50 -0
  117. package/dist/models/JobLogChunk.js +62 -0
  118. package/dist/models/JobLogs.d.ts +39 -0
  119. package/dist/models/JobLogs.js +55 -0
  120. package/dist/models/JobPage.d.ts +39 -0
  121. package/dist/models/JobPage.js +55 -0
  122. package/dist/models/JobSharingHint.d.ts +46 -0
  123. package/dist/models/JobSharingHint.js +58 -0
  124. package/dist/models/JobTelemetry.d.ts +51 -0
  125. package/dist/models/JobTelemetry.js +63 -0
  126. package/dist/models/JobTelemetryPoint.d.ts +56 -0
  127. package/dist/models/JobTelemetryPoint.js +66 -0
  128. package/dist/models/JobTrial.d.ts +79 -0
  129. package/dist/models/JobTrial.js +81 -0
  130. package/dist/models/Secret.d.ts +62 -0
  131. package/dist/models/Secret.js +70 -0
  132. package/dist/models/SecretCreate.d.ts +44 -0
  133. package/dist/models/SecretCreate.js +56 -0
  134. package/dist/models/SecretImportItem.d.ts +38 -0
  135. package/dist/models/SecretImportItem.js +54 -0
  136. package/dist/models/SecretImportRequest.d.ts +39 -0
  137. package/dist/models/SecretImportRequest.js +53 -0
  138. package/dist/models/SecretImportResult.d.ts +44 -0
  139. package/dist/models/SecretImportResult.js +58 -0
  140. package/dist/models/SecretList.d.ts +33 -0
  141. package/dist/models/SecretList.js +51 -0
  142. package/dist/models/SecretPut.d.ts +38 -0
  143. package/dist/models/SecretPut.js +52 -0
  144. package/dist/models/WebhookEndpoint.d.ts +3 -0
  145. package/dist/models/WebhookEndpoint.js +4 -1
  146. package/dist/models/index.d.ts +25 -0
  147. package/dist/models/index.js +25 -0
  148. package/dist/runtime.js +1 -1
  149. package/docs/Balance.md +2 -0
  150. package/docs/BillingApi.md +2 -2
  151. package/docs/DedicatedIPOffer.md +56 -0
  152. package/docs/Endpoint.md +68 -0
  153. package/docs/EndpointCreate.md +50 -0
  154. package/docs/EndpointList.md +34 -0
  155. package/docs/EndpointMachine.md +50 -0
  156. package/docs/EndpointReplicaCounts.md +36 -0
  157. package/docs/EndpointsApi.md +544 -0
  158. package/docs/InstancesApi.md +68 -1
  159. package/docs/Job.md +125 -0
  160. package/docs/JobAttempt.md +69 -0
  161. package/docs/JobCreate.md +66 -0
  162. package/docs/JobGpuTypes.md +36 -0
  163. package/docs/JobGpuTypesDataInner.md +42 -0
  164. package/docs/JobLogChunk.md +40 -0
  165. package/docs/JobLogs.md +36 -0
  166. package/docs/JobPage.md +36 -0
  167. package/docs/JobSharingHint.md +39 -0
  168. package/docs/JobTelemetry.md +40 -0
  169. package/docs/JobTelemetryPoint.md +42 -0
  170. package/docs/JobTrial.md +46 -0
  171. package/docs/JobsApi.md +609 -0
  172. package/docs/OperationsApi.md +76 -0
  173. package/docs/Secret.md +45 -0
  174. package/docs/SecretCreate.md +38 -0
  175. package/docs/SecretImportItem.md +36 -0
  176. package/docs/SecretImportRequest.md +36 -0
  177. package/docs/SecretImportResult.md +38 -0
  178. package/docs/SecretList.md +34 -0
  179. package/docs/SecretPut.md +36 -0
  180. package/docs/SecretsApi.md +450 -0
  181. package/package.json +1 -1
  182. package/src/apis/BillingApi.ts +2 -2
  183. package/src/apis/EndpointsApi.ts +481 -0
  184. package/src/apis/InstancesApi.ts +52 -0
  185. package/src/apis/JobsApi.ts +551 -0
  186. package/src/apis/OperationsApi.ts +59 -0
  187. package/src/apis/SecretsApi.ts +413 -0
  188. package/src/apis/index.ts +3 -0
  189. package/src/models/Balance.ts +8 -0
  190. package/src/models/CreateWebhookEndpointRequest.ts +4 -1
  191. package/src/models/DedicatedIPOffer.ts +165 -0
  192. package/src/models/Endpoint.ts +247 -0
  193. package/src/models/EndpointCreate.ts +132 -0
  194. package/src/models/EndpointList.ts +74 -0
  195. package/src/models/EndpointMachine.ts +151 -0
  196. package/src/models/EndpointReplicaCounts.ts +75 -0
  197. package/src/models/Job.ts +538 -0
  198. package/src/models/JobAttempt.ts +267 -0
  199. package/src/models/JobCreate.ts +221 -0
  200. package/src/models/JobGpuTypes.ts +83 -0
  201. package/src/models/JobGpuTypesDataInner.ts +104 -0
  202. package/src/models/JobLogChunk.ts +93 -0
  203. package/src/models/JobLogs.ts +83 -0
  204. package/src/models/JobPage.ts +83 -0
  205. package/src/models/JobSharingHint.ts +86 -0
  206. package/src/models/JobTelemetry.ts +101 -0
  207. package/src/models/JobTelemetryPoint.ts +102 -0
  208. package/src/models/JobTrial.ts +132 -0
  209. package/src/models/Secret.ts +111 -0
  210. package/src/models/SecretCreate.ts +83 -0
  211. package/src/models/SecretImportItem.ts +75 -0
  212. package/src/models/SecretImportRequest.ts +82 -0
  213. package/src/models/SecretImportResult.ts +84 -0
  214. package/src/models/SecretList.ts +74 -0
  215. package/src/models/SecretPut.ts +74 -0
  216. package/src/models/WebhookEndpoint.ts +4 -1
  217. package/src/models/index.ts +25 -0
  218. package/src/runtime.ts +1 -1
@@ -36,12 +36,18 @@ export * from './CreateSshKeyRequest';
36
36
  export * from './CreateWebhookEndpointRequest';
37
37
  export * from './CryptoDeposit';
38
38
  export * from './DataRetention';
39
+ export * from './DedicatedIPOffer';
39
40
  export * from './DedicatedIPRequest';
40
41
  export * from './Embedding';
41
42
  export * from './EmbeddingsRequest';
42
43
  export * from './EmbeddingsRequestInput';
43
44
  export * from './EmbeddingsResponse';
44
45
  export * from './EmbeddingsUsage';
46
+ export * from './Endpoint';
47
+ export * from './EndpointCreate';
48
+ export * from './EndpointList';
49
+ export * from './EndpointMachine';
50
+ export * from './EndpointReplicaCounts';
45
51
  export * from './Environments';
46
52
  export * from './FileObject';
47
53
  export * from './FineTuningJob';
@@ -79,6 +85,18 @@ export * from './InstanceGpuMemory';
79
85
  export * from './InstancePage';
80
86
  export * from './Invoice';
81
87
  export * from './InvoiceList';
88
+ export * from './Job';
89
+ export * from './JobAttempt';
90
+ export * from './JobCreate';
91
+ export * from './JobGpuTypes';
92
+ export * from './JobGpuTypesDataInner';
93
+ export * from './JobLogChunk';
94
+ export * from './JobLogs';
95
+ export * from './JobPage';
96
+ export * from './JobSharingHint';
97
+ export * from './JobTelemetry';
98
+ export * from './JobTelemetryPoint';
99
+ export * from './JobTrial';
82
100
  export * from './ListCommunityMachines200Response';
83
101
  export * from './ListDeposits200Response';
84
102
  export * from './ListRegistryCredentials200Response';
@@ -103,6 +121,13 @@ export * from './RegisterCommunityMachineRequest';
103
121
  export * from './RegistryCredential';
104
122
  export * from './SSHKey';
105
123
  export * from './SSHKeyPage';
124
+ export * from './Secret';
125
+ export * from './SecretCreate';
126
+ export * from './SecretImportItem';
127
+ export * from './SecretImportRequest';
128
+ export * from './SecretImportResult';
129
+ export * from './SecretList';
130
+ export * from './SecretPut';
106
131
  export * from './SpendingLimit';
107
132
  export * from './StreamOptions';
108
133
  export * from './SupplierMachineView';
@@ -54,12 +54,18 @@ __exportStar(require("./CreateSshKeyRequest"), exports);
54
54
  __exportStar(require("./CreateWebhookEndpointRequest"), exports);
55
55
  __exportStar(require("./CryptoDeposit"), exports);
56
56
  __exportStar(require("./DataRetention"), exports);
57
+ __exportStar(require("./DedicatedIPOffer"), exports);
57
58
  __exportStar(require("./DedicatedIPRequest"), exports);
58
59
  __exportStar(require("./Embedding"), exports);
59
60
  __exportStar(require("./EmbeddingsRequest"), exports);
60
61
  __exportStar(require("./EmbeddingsRequestInput"), exports);
61
62
  __exportStar(require("./EmbeddingsResponse"), exports);
62
63
  __exportStar(require("./EmbeddingsUsage"), exports);
64
+ __exportStar(require("./Endpoint"), exports);
65
+ __exportStar(require("./EndpointCreate"), exports);
66
+ __exportStar(require("./EndpointList"), exports);
67
+ __exportStar(require("./EndpointMachine"), exports);
68
+ __exportStar(require("./EndpointReplicaCounts"), exports);
63
69
  __exportStar(require("./Environments"), exports);
64
70
  __exportStar(require("./FileObject"), exports);
65
71
  __exportStar(require("./FineTuningJob"), exports);
@@ -97,6 +103,18 @@ __exportStar(require("./InstanceGpuMemory"), exports);
97
103
  __exportStar(require("./InstancePage"), exports);
98
104
  __exportStar(require("./Invoice"), exports);
99
105
  __exportStar(require("./InvoiceList"), exports);
106
+ __exportStar(require("./Job"), exports);
107
+ __exportStar(require("./JobAttempt"), exports);
108
+ __exportStar(require("./JobCreate"), exports);
109
+ __exportStar(require("./JobGpuTypes"), exports);
110
+ __exportStar(require("./JobGpuTypesDataInner"), exports);
111
+ __exportStar(require("./JobLogChunk"), exports);
112
+ __exportStar(require("./JobLogs"), exports);
113
+ __exportStar(require("./JobPage"), exports);
114
+ __exportStar(require("./JobSharingHint"), exports);
115
+ __exportStar(require("./JobTelemetry"), exports);
116
+ __exportStar(require("./JobTelemetryPoint"), exports);
117
+ __exportStar(require("./JobTrial"), exports);
100
118
  __exportStar(require("./ListCommunityMachines200Response"), exports);
101
119
  __exportStar(require("./ListDeposits200Response"), exports);
102
120
  __exportStar(require("./ListRegistryCredentials200Response"), exports);
@@ -121,6 +139,13 @@ __exportStar(require("./RegisterCommunityMachineRequest"), exports);
121
139
  __exportStar(require("./RegistryCredential"), exports);
122
140
  __exportStar(require("./SSHKey"), exports);
123
141
  __exportStar(require("./SSHKeyPage"), exports);
142
+ __exportStar(require("./Secret"), exports);
143
+ __exportStar(require("./SecretCreate"), exports);
144
+ __exportStar(require("./SecretImportItem"), exports);
145
+ __exportStar(require("./SecretImportRequest"), exports);
146
+ __exportStar(require("./SecretImportResult"), exports);
147
+ __exportStar(require("./SecretList"), exports);
148
+ __exportStar(require("./SecretPut"), exports);
124
149
  __exportStar(require("./SpendingLimit"), exports);
125
150
  __exportStar(require("./StreamOptions"), exports);
126
151
  __exportStar(require("./SupplierMachineView"), exports);
package/dist/runtime.js CHANGED
@@ -69,7 +69,7 @@ class Configuration {
69
69
  return undefined;
70
70
  }
71
71
  get headers() {
72
- return Object.assign({ 'User-Agent': 'gpuai-sdk-ts/0.5.3' }, this.configuration.headers);
72
+ return Object.assign({ 'User-Agent': 'gpuai-sdk-ts/0.5.5' }, this.configuration.headers);
73
73
  }
74
74
  get credentials() {
75
75
  return this.configuration.credentials;
package/docs/Balance.md CHANGED
@@ -13,6 +13,7 @@ Name | Type
13
13
  `autoPayThresholdCents` | number
14
14
  `autoPayAmountCents` | number
15
15
  `burnCentsPerHour` | number
16
+ `runwayHours` | number
16
17
 
17
18
  ## Example
18
19
 
@@ -27,6 +28,7 @@ const example = {
27
28
  "autoPayThresholdCents": null,
28
29
  "autoPayAmountCents": null,
29
30
  "burnCentsPerHour": null,
31
+ "runwayHours": null,
30
32
  } satisfies Balance
31
33
 
32
34
  console.log(example)
@@ -174,7 +174,7 @@ example().catch(console.error);
174
174
 
175
175
  Get the org credit balance
176
176
 
177
- Returns the organization\'s credit balance, its auto-pay configuration, and the live burn rate. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter. Divide `balance_cents` by `burn_cents_per_hour` for the remaining runway in hours. The quotient is undefined in three cases a caller must keep apart: `burn_cents_per_hour` is 0 (nothing running, so the balance funds unbounded idle time), it is `null` (the burn rate could not be determined — NOT the same as idle), or the balance is already at or below zero. This is the balance itself — for spend against a configured cap see `/billing/spending-limit`, and for past consumption see `/usage`.
177
+ Returns the organization\'s credit balance, its auto-pay configuration, and the live burn rate. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter. Divide `balance_cents` by `burn_cents_per_hour` for the remaining runway in hours. The quotient is undefined in three cases a caller must keep apart: `burn_cents_per_hour` is 0 (nothing running, so the balance funds unbounded idle time), it is `null` (the burn rate could not be determined — NOT the same as idle), or the balance is already at or below zero. This is the balance itself — for spend against a configured cap see `/billing/spending-limit`, and for past consumption see `/usage`. `runway_hours` does that division for you, adding serverless inference spend over the last hour to the burn. While it is under the low-balance threshold (2 hours by default) and auto-pay is off or failing, every authenticated response carries the `GPUAI-Balance-Warning` header.
178
178
 
179
179
  ### Example
180
180
 
@@ -226,7 +226,7 @@ This endpoint does not need any parameter.
226
226
  ### HTTP response details
227
227
  | Status code | Description | Response headers |
228
228
  |-------------|-------------|------------------|
229
- | **200** | OK | - |
229
+ | **200** | OK | * GPUAI-Balance-Warning - <br> |
230
230
  | **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
231
231
  | **0** | Error response (RFC 7807) | - |
232
232
 
@@ -0,0 +1,56 @@
1
+
2
+ # DedicatedIPOffer
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `enabled` | boolean
10
+ `allowedPorts` | string
11
+ `defaultPorts` | Array&lt;number&gt;
12
+ `maxPorts` | number
13
+ `hourlyFee` | number
14
+ `transferPricePerGb` | number
15
+ `transferIncludedGb` | number
16
+ `transferCapGb` | number
17
+ `orgLimit` | number
18
+ `orgInUse` | number
19
+ `available` | number
20
+ `acceptableUse` | string
21
+
22
+ ## Example
23
+
24
+ ```typescript
25
+ import type { DedicatedIPOffer } from '@gpuai/sdk'
26
+
27
+ // TODO: Update the object below with actual values
28
+ const example = {
29
+ "enabled": null,
30
+ "allowedPorts": 80,443,
31
+ "defaultPorts": [80, 443],
32
+ "maxPorts": 8,
33
+ "hourlyFee": 0.01,
34
+ "transferPricePerGb": 0.12,
35
+ "transferIncludedGb": 0,
36
+ "transferCapGb": 500,
37
+ "orgLimit": 2,
38
+ "orgInUse": null,
39
+ "available": null,
40
+ "acceptableUse": null,
41
+ } satisfies DedicatedIPOffer
42
+
43
+ console.log(example)
44
+
45
+ // Convert the instance to a JSON string
46
+ const exampleJSON: string = JSON.stringify(example)
47
+ console.log(exampleJSON)
48
+
49
+ // Parse the JSON string back to an object
50
+ const exampleParsed = JSON.parse(exampleJSON) as DedicatedIPOffer
51
+ console.log(exampleParsed)
52
+ ```
53
+
54
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
55
+
56
+
@@ -0,0 +1,68 @@
1
+
2
+ # Endpoint
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `name` | string
11
+ `model` | string
12
+ `gpuType` | string
13
+ `status` | string
14
+ `url` | string
15
+ `minReplicas` | number
16
+ `maxReplicas` | number
17
+ `idleTimeout` | number
18
+ `targetConcurrency` | number
19
+ `maxPricePerHour` | number
20
+ `hfTokenSecret` | string
21
+ `replicas` | [EndpointReplicaCounts](EndpointReplicaCounts.md)
22
+ `requestCount` | number
23
+ `lastRequestAt` | Date
24
+ `lastError` | string
25
+ `createdAt` | Date
26
+ `machines` | [Array&lt;EndpointMachine&gt;](EndpointMachine.md)
27
+
28
+ ## Example
29
+
30
+ ```typescript
31
+ import type { Endpoint } from '@gpuai/sdk'
32
+
33
+ // TODO: Update the object below with actual values
34
+ const example = {
35
+ "id": null,
36
+ "name": null,
37
+ "model": null,
38
+ "gpuType": null,
39
+ "status": null,
40
+ "url": https://api.gpu.ai/v1/endpoints/3f1c2a7e-0000-4000-8000-000000000000/openai/v1,
41
+ "minReplicas": null,
42
+ "maxReplicas": null,
43
+ "idleTimeout": null,
44
+ "targetConcurrency": null,
45
+ "maxPricePerHour": null,
46
+ "hfTokenSecret": null,
47
+ "replicas": null,
48
+ "requestCount": null,
49
+ "lastRequestAt": null,
50
+ "lastError": null,
51
+ "createdAt": null,
52
+ "machines": null,
53
+ } satisfies Endpoint
54
+
55
+ console.log(example)
56
+
57
+ // Convert the instance to a JSON string
58
+ const exampleJSON: string = JSON.stringify(example)
59
+ console.log(exampleJSON)
60
+
61
+ // Parse the JSON string back to an object
62
+ const exampleParsed = JSON.parse(exampleJSON) as Endpoint
63
+ console.log(exampleParsed)
64
+ ```
65
+
66
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
67
+
68
+
@@ -0,0 +1,50 @@
1
+
2
+ # EndpointCreate
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `model` | string
11
+ `gpuType` | string
12
+ `minReplicas` | number
13
+ `maxReplicas` | number
14
+ `idleTimeout` | number
15
+ `targetConcurrency` | number
16
+ `maxPricePerHour` | number
17
+ `hfTokenSecret` | string
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import type { EndpointCreate } from '@gpuai/sdk'
23
+
24
+ // TODO: Update the object below with actual values
25
+ const example = {
26
+ "name": qwen-small,
27
+ "model": Qwen/Qwen2.5-0.5B-Instruct,
28
+ "gpuType": rtx_4090,
29
+ "minReplicas": null,
30
+ "maxReplicas": null,
31
+ "idleTimeout": null,
32
+ "targetConcurrency": null,
33
+ "maxPricePerHour": null,
34
+ "hfTokenSecret": null,
35
+ } satisfies EndpointCreate
36
+
37
+ console.log(example)
38
+
39
+ // Convert the instance to a JSON string
40
+ const exampleJSON: string = JSON.stringify(example)
41
+ console.log(exampleJSON)
42
+
43
+ // Parse the JSON string back to an object
44
+ const exampleParsed = JSON.parse(exampleJSON) as EndpointCreate
45
+ console.log(exampleParsed)
46
+ ```
47
+
48
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
49
+
50
+
@@ -0,0 +1,34 @@
1
+
2
+ # EndpointList
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array&lt;Endpoint&gt;](Endpoint.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { EndpointList } from '@gpuai/sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies EndpointList
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as EndpointList
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,50 @@
1
+
2
+ # EndpointMachine
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `status` | string
11
+ `instanceId` | string
12
+ `gpuType` | string
13
+ `pricePerHour` | number
14
+ `readyAt` | Date
15
+ `terminatedAt` | Date
16
+ `terminateReason` | string
17
+ `createdAt` | Date
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import type { EndpointMachine } from '@gpuai/sdk'
23
+
24
+ // TODO: Update the object below with actual values
25
+ const example = {
26
+ "id": null,
27
+ "status": null,
28
+ "instanceId": null,
29
+ "gpuType": null,
30
+ "pricePerHour": null,
31
+ "readyAt": null,
32
+ "terminatedAt": null,
33
+ "terminateReason": null,
34
+ "createdAt": null,
35
+ } satisfies EndpointMachine
36
+
37
+ console.log(example)
38
+
39
+ // Convert the instance to a JSON string
40
+ const exampleJSON: string = JSON.stringify(example)
41
+ console.log(exampleJSON)
42
+
43
+ // Parse the JSON string back to an object
44
+ const exampleParsed = JSON.parse(exampleJSON) as EndpointMachine
45
+ console.log(exampleParsed)
46
+ ```
47
+
48
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
49
+
50
+
@@ -0,0 +1,36 @@
1
+
2
+ # EndpointReplicaCounts
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `starting` | number
10
+ `ready` | number
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { EndpointReplicaCounts } from '@gpuai/sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "starting": null,
20
+ "ready": null,
21
+ } satisfies EndpointReplicaCounts
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 EndpointReplicaCounts
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
+