@blaxel/core 0.2.59-preview.42 → 0.2.59-preview.43

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 (63) hide show
  1. package/dist/cjs/.tsbuildinfo +1 -1
  2. package/dist/cjs/client/sdk.gen.js +142 -155
  3. package/dist/cjs/common/settings.js +2 -2
  4. package/dist/cjs/sandbox/action.js +2 -2
  5. package/dist/cjs/sandbox/client/sdk.gen.js +1 -103
  6. package/dist/cjs/sandbox/interpreter.js +7 -4
  7. package/dist/cjs/sandbox/preview.js +11 -8
  8. package/dist/cjs/sandbox/sandbox.js +3 -3
  9. package/dist/cjs/sandbox/session.js +11 -11
  10. package/dist/cjs/sandbox/types.js +4 -1
  11. package/dist/cjs/tools/index.js +1 -3
  12. package/dist/cjs/types/client/sdk.gen.d.ts +177 -166
  13. package/dist/cjs/types/client/types.gen.d.ts +1805 -1375
  14. package/dist/cjs/types/sandbox/client/sdk.gen.d.ts +1 -31
  15. package/dist/cjs/types/sandbox/client/types.gen.d.ts +0 -83
  16. package/dist/cjs/types/sandbox/preview.d.ts +2 -2
  17. package/dist/cjs/types/sandbox/sandbox.d.ts +3 -3
  18. package/dist/cjs/types/volume/index.d.ts +3 -3
  19. package/dist/cjs/volume/index.js +12 -14
  20. package/dist/cjs-browser/.tsbuildinfo +1 -1
  21. package/dist/cjs-browser/client/sdk.gen.js +142 -155
  22. package/dist/cjs-browser/common/settings.js +2 -2
  23. package/dist/cjs-browser/sandbox/action.js +2 -2
  24. package/dist/cjs-browser/sandbox/client/sdk.gen.js +1 -103
  25. package/dist/cjs-browser/sandbox/interpreter.js +7 -4
  26. package/dist/cjs-browser/sandbox/preview.js +11 -8
  27. package/dist/cjs-browser/sandbox/sandbox.js +3 -3
  28. package/dist/cjs-browser/sandbox/session.js +11 -11
  29. package/dist/cjs-browser/sandbox/types.js +4 -1
  30. package/dist/cjs-browser/tools/index.js +1 -3
  31. package/dist/cjs-browser/types/client/sdk.gen.d.ts +177 -166
  32. package/dist/cjs-browser/types/client/types.gen.d.ts +1805 -1375
  33. package/dist/cjs-browser/types/sandbox/client/sdk.gen.d.ts +1 -31
  34. package/dist/cjs-browser/types/sandbox/client/types.gen.d.ts +0 -83
  35. package/dist/cjs-browser/types/sandbox/preview.d.ts +2 -2
  36. package/dist/cjs-browser/types/sandbox/sandbox.d.ts +3 -3
  37. package/dist/cjs-browser/types/volume/index.d.ts +3 -3
  38. package/dist/cjs-browser/volume/index.js +12 -14
  39. package/dist/esm/.tsbuildinfo +1 -1
  40. package/dist/esm/client/sdk.gen.js +140 -151
  41. package/dist/esm/common/settings.js +2 -2
  42. package/dist/esm/sandbox/action.js +2 -2
  43. package/dist/esm/sandbox/client/sdk.gen.js +0 -96
  44. package/dist/esm/sandbox/interpreter.js +7 -4
  45. package/dist/esm/sandbox/preview.js +11 -8
  46. package/dist/esm/sandbox/sandbox.js +3 -3
  47. package/dist/esm/sandbox/session.js +11 -11
  48. package/dist/esm/sandbox/types.js +4 -1
  49. package/dist/esm/tools/index.js +1 -3
  50. package/dist/esm/volume/index.js +12 -14
  51. package/dist/esm-browser/.tsbuildinfo +1 -1
  52. package/dist/esm-browser/client/sdk.gen.js +140 -151
  53. package/dist/esm-browser/common/settings.js +2 -2
  54. package/dist/esm-browser/sandbox/action.js +2 -2
  55. package/dist/esm-browser/sandbox/client/sdk.gen.js +0 -96
  56. package/dist/esm-browser/sandbox/interpreter.js +7 -4
  57. package/dist/esm-browser/sandbox/preview.js +11 -8
  58. package/dist/esm-browser/sandbox/sandbox.js +3 -3
  59. package/dist/esm-browser/sandbox/session.js +11 -11
  60. package/dist/esm-browser/sandbox/types.js +4 -1
  61. package/dist/esm-browser/tools/index.js +1 -3
  62. package/dist/esm-browser/volume/index.js +12 -14
  63. package/package.json +1 -1
@@ -2,11 +2,12 @@
2
2
  // This file is auto-generated by @hey-api/openapi-ts
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.updateModel = exports.getModel = exports.deleteModel = exports.createModel = exports.listModels = exports.listMcpHubDefinitions = exports.listLocations = exports.listJobRevisions = exports.getJobExecution = exports.deleteJobExecution = exports.createJobExecution = exports.listJobExecutions = exports.updateJob = exports.getJob = exports.deleteJob = exports.createJob = exports.listJobs = exports.getIntegrationConnectionModel = exports.listIntegrationConnectionModels = exports.getIntegrationConnectionModelEndpointConfigurations = exports.updateIntegrationConnection = exports.getIntegrationConnection = exports.deleteIntegrationConnection = exports.createIntegrationConnection = exports.listIntegrationConnections = exports.getIntegration = exports.deleteImageTag = exports.getImage = exports.deleteImage = exports.listImages = exports.cleanupImages = exports.listFunctionRevisions = exports.updateFunction = exports.getFunction = exports.deleteFunction = exports.createFunction = exports.listFunctions = exports.verifyCustomDomain = exports.updateCustomDomain = exports.getCustomDomain = exports.deleteCustomDomain = exports.createCustomDomain = exports.listCustomDomains = exports.getConfiguration = exports.listAgentRevisions = exports.updateAgent = exports.getAgent = exports.deleteAgent = exports.createAgent = exports.listAgents = void 0;
5
- exports.deleteWorkspace = exports.createWorkspace = exports.listWorkspaces = exports.getVolume = exports.deleteVolume = exports.createVolume = exports.listVolumes = exports.deleteVolumeTemplateVersion = exports.updateVolumeTemplate = exports.getVolumeTemplate = exports.deleteVolumeTemplate = exports.createVolumeTemplate = exports.listVolumeTemplates = exports.updateWorkspaceUserRole = exports.removeWorkspaceUser = exports.inviteWorkspaceUser = exports.listWorkspaceUsers = exports.getTemplate = exports.listTemplates = exports.deleteApiKeyForServiceAccount = exports.createApiKeyForServiceAccount = exports.listApiKeysForServiceAccount = exports.updateWorkspaceServiceAccount = exports.deleteWorkspaceServiceAccount = exports.createWorkspaceServiceAccount = exports.getWorkspaceServiceAccounts = exports.stopSandbox = exports.startSandbox = exports.deleteSandboxPreviewToken = exports.createSandboxPreviewToken = exports.listSandboxPreviewTokens = exports.updateSandboxPreview = exports.getSandboxPreview = exports.deleteSandboxPreview = exports.createSandboxPreview = exports.listSandboxPreviews = exports.updateSandbox = exports.getSandbox = exports.deleteSandbox = exports.createSandbox = exports.listSandboxes = exports.listSandboxHubDefinitions = exports.listPublicIps = exports.listAllPendingInvitations = exports.updatePolicy = exports.getPolicy = exports.deletePolicy = exports.createPolicy = exports.listPolicies = exports.listModelRevisions = void 0;
6
- exports.checkWorkspaceAvailability = exports.leaveWorkspace = exports.acceptWorkspaceInvitation = exports.declineWorkspaceInvitation = exports.updateWorkspace = exports.getWorkspace = void 0;
5
+ exports.updateWorkspace = exports.getWorkspace = exports.deleteWorkspace = exports.createWorkspace = exports.listWorkspaces = exports.getVolume = exports.deleteVolume = exports.createVolume = exports.listVolumes = exports.deleteVolumeTemplateVersion = exports.updateVolumeTemplate = exports.getVolumeTemplate = exports.deleteVolumeTemplate = exports.createVolumeTemplate = exports.listVolumeTemplates = exports.updateWorkspaceUserRole = exports.removeWorkspaceUser = exports.inviteWorkspaceUser = exports.listWorkspaceUsers = exports.getTemplate = exports.listTemplates = exports.deleteApiKeyForServiceAccount = exports.createApiKeyForServiceAccount = exports.listApiKeysForServiceAccount = exports.updateWorkspaceServiceAccount = exports.deleteWorkspaceServiceAccount = exports.createWorkspaceServiceAccount = exports.getWorkspaceServiceAccounts = exports.deleteSandboxPreviewToken = exports.createSandboxPreviewToken = exports.listSandboxPreviewTokens = exports.updateSandboxPreview = exports.getSandboxPreview = exports.deleteSandboxPreview = exports.createSandboxPreview = exports.listSandboxPreviews = exports.updateSandbox = exports.getSandbox = exports.deleteSandbox = exports.createSandbox = exports.listSandboxes = exports.listSandboxHubDefinitions = exports.listPublicIps = exports.listAllPendingInvitations = exports.updatePolicy = exports.getPolicy = exports.deletePolicy = exports.createPolicy = exports.listPolicies = exports.listModelRevisions = void 0;
6
+ exports.checkWorkspaceAvailability = exports.leaveWorkspace = exports.acceptWorkspaceInvitation = exports.declineWorkspaceInvitation = void 0;
7
7
  const client_gen_1 = require("./client.gen");
8
8
  /**
9
9
  * List all agents
10
+ * Returns all AI agents deployed in the workspace. Each agent includes its deployment status, runtime configuration, and global inference endpoint URL.
10
11
  */
11
12
  const listAgents = (options) => {
12
13
  return (options?.client ?? client_gen_1.client).get({
@@ -22,7 +23,8 @@ const listAgents = (options) => {
22
23
  };
23
24
  exports.listAgents = listAgents;
24
25
  /**
25
- * Create agent by name
26
+ * Create agent
27
+ * Creates a new AI agent deployment from your code. The agent will be built and deployed as a serverless auto-scaling endpoint. Use the Blaxel CLI 'bl deploy' for a simpler deployment experience.
26
28
  */
27
29
  const createAgent = (options) => {
28
30
  return (options.client ?? client_gen_1.client).post({
@@ -42,7 +44,8 @@ const createAgent = (options) => {
42
44
  };
43
45
  exports.createAgent = createAgent;
44
46
  /**
45
- * Delete agent by name
47
+ * Delete agent
48
+ * Permanently deletes an agent and all its deployment history. The agent's inference endpoint will immediately stop responding. This action cannot be undone.
46
49
  */
47
50
  const deleteAgent = (options) => {
48
51
  return (options.client ?? client_gen_1.client).delete({
@@ -58,7 +61,8 @@ const deleteAgent = (options) => {
58
61
  };
59
62
  exports.deleteAgent = deleteAgent;
60
63
  /**
61
- * Get agent by name
64
+ * Get agent
65
+ * Returns detailed information about an agent including its current deployment status, configuration, events history, and inference endpoint URL.
62
66
  */
63
67
  const getAgent = (options) => {
64
68
  return (options.client ?? client_gen_1.client).get({
@@ -74,7 +78,8 @@ const getAgent = (options) => {
74
78
  };
75
79
  exports.getAgent = getAgent;
76
80
  /**
77
- * Update agent by name
81
+ * Update agent
82
+ * Updates an agent's configuration and triggers a new deployment. Changes to runtime settings, environment variables, or scaling parameters will be applied on the next deployment.
78
83
  */
79
84
  const updateAgent = (options) => {
80
85
  return (options.client ?? client_gen_1.client).put({
@@ -110,7 +115,8 @@ const listAgentRevisions = (options) => {
110
115
  };
111
116
  exports.listAgentRevisions = listAgentRevisions;
112
117
  /**
113
- * List all configurations
118
+ * Get platform configuration
119
+ * Returns global platform configuration including available regions, countries, continents, and private locations for deployment policies.
114
120
  */
115
121
  const getConfiguration = (options) => {
116
122
  return (options?.client ?? client_gen_1.client).get({
@@ -126,7 +132,8 @@ const getConfiguration = (options) => {
126
132
  };
127
133
  exports.getConfiguration = getConfiguration;
128
134
  /**
129
- * List all custom domains
135
+ * List custom domains
136
+ * Returns all custom domains configured in the workspace. Custom domains allow serving preview deployments under your own domain (e.g., preview.yourdomain.com).
130
137
  */
131
138
  const listCustomDomains = (options) => {
132
139
  return (options?.client ?? client_gen_1.client).get({
@@ -143,6 +150,7 @@ const listCustomDomains = (options) => {
143
150
  exports.listCustomDomains = listCustomDomains;
144
151
  /**
145
152
  * Create custom domain
153
+ * Creates a new custom domain for preview deployments. After creation, you must configure DNS records and verify domain ownership before it becomes active.
146
154
  */
147
155
  const createCustomDomain = (options) => {
148
156
  return (options.client ?? client_gen_1.client).post({
@@ -230,7 +238,8 @@ const verifyCustomDomain = (options) => {
230
238
  };
231
239
  exports.verifyCustomDomain = verifyCustomDomain;
232
240
  /**
233
- * List all functions
241
+ * List all MCP servers
242
+ * Returns all MCP server functions deployed in the workspace. Each function includes its deployment status, transport protocol (websocket or http-stream), and endpoint URL.
234
243
  */
235
244
  const listFunctions = (options) => {
236
245
  return (options?.client ?? client_gen_1.client).get({
@@ -246,7 +255,8 @@ const listFunctions = (options) => {
246
255
  };
247
256
  exports.listFunctions = listFunctions;
248
257
  /**
249
- * Create function
258
+ * Create MCP server
259
+ * Creates a new MCP server function deployment. The function will expose tools via the Model Context Protocol that can be used by AI agents. Supports streamable HTTP transport.
250
260
  */
251
261
  const createFunction = (options) => {
252
262
  return (options.client ?? client_gen_1.client).post({
@@ -266,7 +276,8 @@ const createFunction = (options) => {
266
276
  };
267
277
  exports.createFunction = createFunction;
268
278
  /**
269
- * Delete function by name
279
+ * Delete MCP server
280
+ * Permanently deletes an MCP server function and all its deployment history. Any agents using this function's tools will no longer be able to invoke them.
270
281
  */
271
282
  const deleteFunction = (options) => {
272
283
  return (options.client ?? client_gen_1.client).delete({
@@ -282,7 +293,8 @@ const deleteFunction = (options) => {
282
293
  };
283
294
  exports.deleteFunction = deleteFunction;
284
295
  /**
285
- * Get function by name
296
+ * Get MCP server
297
+ * Returns detailed information about an MCP server function including its deployment status, available tools, transport configuration, and endpoint URL.
286
298
  */
287
299
  const getFunction = (options) => {
288
300
  return (options.client ?? client_gen_1.client).get({
@@ -298,7 +310,8 @@ const getFunction = (options) => {
298
310
  };
299
311
  exports.getFunction = getFunction;
300
312
  /**
301
- * Update function by name
313
+ * Update MCP server
314
+ * Updates an MCP server function's configuration and triggers a new deployment. Changes to runtime settings, integrations, or transport protocol will be applied on the next deployment.
302
315
  */
303
316
  const updateFunction = (options) => {
304
317
  return (options.client ?? client_gen_1.client).put({
@@ -335,8 +348,8 @@ const listFunctionRevisions = (options) => {
335
348
  };
336
349
  exports.listFunctionRevisions = listFunctionRevisions;
337
350
  /**
338
- * Cleanup unused images
339
- * Deletes all unused images in the workspace. Only removes images that are not currently being used by any agents, functions, sandboxes, or jobs.
351
+ * Cleanup unused container images
352
+ * Cleans up unused container images in the workspace registry. Only removes images that are not currently referenced by any active agent, function, sandbox, or job deployment.
340
353
  */
341
354
  const cleanupImages = (options) => {
342
355
  return (options?.client ?? client_gen_1.client).delete({
@@ -352,8 +365,8 @@ const cleanupImages = (options) => {
352
365
  };
353
366
  exports.cleanupImages = cleanupImages;
354
367
  /**
355
- * List images
356
- * Returns a list of all images in the workspace grouped by repository with tags.
368
+ * List container images
369
+ * Returns all container images stored in the workspace registry, grouped by repository with their available tags. Images are created during deployments of agents, functions, sandboxes, and jobs.
357
370
  */
358
371
  const listImages = (options) => {
359
372
  return (options?.client ?? client_gen_1.client).get({
@@ -369,8 +382,8 @@ const listImages = (options) => {
369
382
  };
370
383
  exports.listImages = listImages;
371
384
  /**
372
- * Delete image by name
373
- * Deletes an image by name.
385
+ * Delete container image
386
+ * Deletes a container image and all its tags from the workspace registry. Will fail if the image is currently in use by an active deployment.
374
387
  */
375
388
  const deleteImage = (options) => {
376
389
  return (options.client ?? client_gen_1.client).delete({
@@ -386,8 +399,8 @@ const deleteImage = (options) => {
386
399
  };
387
400
  exports.deleteImage = deleteImage;
388
401
  /**
389
- * Get image by name
390
- * Returns an image by name.
402
+ * Get container image
403
+ * Returns detailed information about a container image including all available tags, creation dates, and size information.
391
404
  */
392
405
  const getImage = (options) => {
393
406
  return (options.client ?? client_gen_1.client).get({
@@ -403,8 +416,8 @@ const getImage = (options) => {
403
416
  };
404
417
  exports.getImage = getImage;
405
418
  /**
406
- * Delete image tag
407
- * Deletes a specific tag from an image.
419
+ * Delete container image tag
420
+ * Deletes a specific tag from a container image. The underlying image layers are kept if other tags reference them. Will fail if the tag is currently in use.
408
421
  */
409
422
  const deleteImageTag = (options) => {
410
423
  return (options.client ?? client_gen_1.client).delete({
@@ -420,8 +433,8 @@ const deleteImageTag = (options) => {
420
433
  };
421
434
  exports.deleteImageTag = deleteImageTag;
422
435
  /**
423
- * List integrations connections
424
- * Returns integration information by name.
436
+ * Get integration provider info
437
+ * Returns metadata about an integration provider including available endpoints, authentication methods, and supported models or features.
425
438
  */
426
439
  const getIntegration = (options) => {
427
440
  return (options.client ?? client_gen_1.client).get({
@@ -437,8 +450,8 @@ const getIntegration = (options) => {
437
450
  };
438
451
  exports.getIntegration = getIntegration;
439
452
  /**
440
- * List integrations connections
441
- * Returns a list of all connections integrations in the workspace.
453
+ * List integration connections
454
+ * Returns all configured integration connections in the workspace. Each connection stores credentials and settings for an external service (LLM provider, API, database).
442
455
  */
443
456
  const listIntegrationConnections = (options) => {
444
457
  return (options?.client ?? client_gen_1.client).get({
@@ -454,8 +467,8 @@ const listIntegrationConnections = (options) => {
454
467
  };
455
468
  exports.listIntegrationConnections = listIntegrationConnections;
456
469
  /**
457
- * Create integration
458
- * Create a connection for an integration.
470
+ * Create integration connection
471
+ * Creates a new integration connection with credentials for an external service. The connection can then be used by models, functions, and other resources to authenticate with the service.
459
472
  */
460
473
  const createIntegrationConnection = (options) => {
461
474
  return (options.client ?? client_gen_1.client).post({
@@ -475,8 +488,8 @@ const createIntegrationConnection = (options) => {
475
488
  };
476
489
  exports.createIntegrationConnection = createIntegrationConnection;
477
490
  /**
478
- * Delete integration
479
- * Deletes an integration connection by integration name and connection name.
491
+ * Delete integration connection
492
+ * Permanently deletes an integration connection. Any resources using this connection will lose access to the external service.
480
493
  */
481
494
  const deleteIntegrationConnection = (options) => {
482
495
  return (options.client ?? client_gen_1.client).delete({
@@ -492,8 +505,8 @@ const deleteIntegrationConnection = (options) => {
492
505
  };
493
506
  exports.deleteIntegrationConnection = deleteIntegrationConnection;
494
507
  /**
495
- * Get integration
496
- * Returns an integration connection by integration name and connection name.
508
+ * Get integration connection
509
+ * Returns detailed information about an integration connection including its provider type, configuration (secrets are masked), and usage status.
497
510
  */
498
511
  const getIntegrationConnection = (options) => {
499
512
  return (options.client ?? client_gen_1.client).get({
@@ -510,7 +523,7 @@ const getIntegrationConnection = (options) => {
510
523
  exports.getIntegrationConnection = getIntegrationConnection;
511
524
  /**
512
525
  * Update integration connection
513
- * Update an integration connection by integration name and connection name.
526
+ * Updates an integration connection's configuration or credentials. Changes take effect immediately for all resources using this connection.
514
527
  */
515
528
  const updateIntegrationConnection = (options) => {
516
529
  return (options.client ?? client_gen_1.client).put({
@@ -564,7 +577,7 @@ const listIntegrationConnectionModels = (options) => {
564
577
  };
565
578
  exports.listIntegrationConnectionModels = listIntegrationConnectionModels;
566
579
  /**
567
- * Get integration model endpoint configurations
580
+ * Get integration connection model
568
581
  * Returns a model for an integration connection by ID.
569
582
  */
570
583
  const getIntegrationConnectionModel = (options) => {
@@ -581,8 +594,8 @@ const getIntegrationConnectionModel = (options) => {
581
594
  };
582
595
  exports.getIntegrationConnectionModel = getIntegrationConnectionModel;
583
596
  /**
584
- * List jobs
585
- * Returns a list of all jobs in the workspace.
597
+ * List batch jobs
598
+ * Returns all batch job definitions in the workspace. Each job can be triggered to run multiple parallel tasks with configurable concurrency and retry settings.
586
599
  */
587
600
  const listJobs = (options) => {
588
601
  return (options?.client ?? client_gen_1.client).get({
@@ -598,8 +611,8 @@ const listJobs = (options) => {
598
611
  };
599
612
  exports.listJobs = listJobs;
600
613
  /**
601
- * Create job
602
- * Creates a job.
614
+ * Create batch job
615
+ * Creates a new batch job definition for parallel AI task processing. Jobs can be triggered via API or scheduled, and support configurable parallelism, timeouts, and retry logic.
603
616
  */
604
617
  const createJob = (options) => {
605
618
  return (options.client ?? client_gen_1.client).post({
@@ -619,8 +632,8 @@ const createJob = (options) => {
619
632
  };
620
633
  exports.createJob = createJob;
621
634
  /**
622
- * Delete job
623
- * Deletes a job by name.
635
+ * Delete batch job
636
+ * Permanently deletes a batch job definition and cancels any running executions. Historical execution data will be retained for a limited time.
624
637
  */
625
638
  const deleteJob = (options) => {
626
639
  return (options.client ?? client_gen_1.client).delete({
@@ -636,8 +649,8 @@ const deleteJob = (options) => {
636
649
  };
637
650
  exports.deleteJob = deleteJob;
638
651
  /**
639
- * Get job
640
- * Returns a job by name.
652
+ * Get batch job
653
+ * Returns detailed information about a batch job including its runtime configuration, execution history, and deployment status.
641
654
  */
642
655
  const getJob = (options) => {
643
656
  return (options.client ?? client_gen_1.client).get({
@@ -653,8 +666,8 @@ const getJob = (options) => {
653
666
  };
654
667
  exports.getJob = getJob;
655
668
  /**
656
- * Create or update job
657
- * Update a job by name.
669
+ * Update batch job
670
+ * Updates a batch job's configuration. Changes affect new executions; running executions continue with their original configuration.
658
671
  */
659
672
  const updateJob = (options) => {
660
673
  return (options.client ?? client_gen_1.client).put({
@@ -675,7 +688,7 @@ const updateJob = (options) => {
675
688
  exports.updateJob = updateJob;
676
689
  /**
677
690
  * List job executions
678
- * Returns a list of all executions for a job by name.
691
+ * Returns paginated list of executions for a batch job, sorted by creation time. Each execution contains status, task counts, and timing information.
679
692
  */
680
693
  const listJobExecutions = (options) => {
681
694
  return (options.client ?? client_gen_1.client).get({
@@ -692,7 +705,7 @@ const listJobExecutions = (options) => {
692
705
  exports.listJobExecutions = listJobExecutions;
693
706
  /**
694
707
  * Create job execution
695
- * Creates a new execution for a job by name.
708
+ * Triggers a new execution of the batch job. Each execution runs multiple tasks in parallel according to the job's configured concurrency. Tasks can be parameterized via the request body.
696
709
  */
697
710
  const createJobExecution = (options) => {
698
711
  return (options.client ?? client_gen_1.client).post({
@@ -712,8 +725,8 @@ const createJobExecution = (options) => {
712
725
  };
713
726
  exports.createJobExecution = createJobExecution;
714
727
  /**
715
- * Delete job execution
716
- * Stop an execution for a job by name.
728
+ * Cancel job execution
729
+ * Cancels a running job execution. Tasks already in progress will complete, but no new tasks will be started. The execution status changes to 'cancelling' then 'cancelled'.
717
730
  */
718
731
  const deleteJobExecution = (options) => {
719
732
  return (options.client ?? client_gen_1.client).delete({
@@ -730,7 +743,7 @@ const deleteJobExecution = (options) => {
730
743
  exports.deleteJobExecution = deleteJobExecution;
731
744
  /**
732
745
  * Get job execution
733
- * Returns an execution for a job by name.
746
+ * Returns detailed information about a specific job execution including status, task statistics (success/failure/running counts), and timing information.
734
747
  */
735
748
  const getJobExecution = (options) => {
736
749
  return (options.client ?? client_gen_1.client).get({
@@ -763,8 +776,8 @@ const listJobRevisions = (options) => {
763
776
  };
764
777
  exports.listJobRevisions = listJobRevisions;
765
778
  /**
766
- * List locations
767
- * Returns a list of all locations available with status.
779
+ * List deployment regions
780
+ * Returns all deployment regions with their current availability status and supported hardware flavors. Use this to discover where resources can be deployed.
768
781
  */
769
782
  const listLocations = (options) => {
770
783
  return (options?.client ?? client_gen_1.client).get({
@@ -779,6 +792,10 @@ const listLocations = (options) => {
779
792
  });
780
793
  };
781
794
  exports.listLocations = listLocations;
795
+ /**
796
+ * List MCP Hub servers
797
+ * Returns all pre-built MCP server definitions available in the Blaxel Hub. These can be deployed directly to your workspace with pre-configured tools and integrations.
798
+ */
782
799
  const listMcpHubDefinitions = (options) => {
783
800
  return (options?.client ?? client_gen_1.client).get({
784
801
  security: [
@@ -793,8 +810,8 @@ const listMcpHubDefinitions = (options) => {
793
810
  };
794
811
  exports.listMcpHubDefinitions = listMcpHubDefinitions;
795
812
  /**
796
- * List models
797
- * Returns a list of all models in the workspace.
813
+ * List model endpoints
814
+ * Returns all model gateway endpoints configured in the workspace. Each model represents a proxy to an external LLM provider (OpenAI, Anthropic, etc.) with unified access control.
798
815
  */
799
816
  const listModels = (options) => {
800
817
  return (options?.client ?? client_gen_1.client).get({
@@ -810,8 +827,8 @@ const listModels = (options) => {
810
827
  };
811
828
  exports.listModels = listModels;
812
829
  /**
813
- * Create model
814
- * Creates a model.
830
+ * Create model endpoint
831
+ * Creates a new model gateway endpoint that proxies requests to an external LLM provider. Requires an integration connection with valid API credentials for the target provider.
815
832
  */
816
833
  const createModel = (options) => {
817
834
  return (options.client ?? client_gen_1.client).post({
@@ -831,8 +848,8 @@ const createModel = (options) => {
831
848
  };
832
849
  exports.createModel = createModel;
833
850
  /**
834
- * Delete model
835
- * Deletes a model by name.
851
+ * Delete model endpoint
852
+ * Permanently deletes a model gateway endpoint. Any agents or applications using this endpoint will need to be updated to use a different model.
836
853
  */
837
854
  const deleteModel = (options) => {
838
855
  return (options.client ?? client_gen_1.client).delete({
@@ -848,8 +865,8 @@ const deleteModel = (options) => {
848
865
  };
849
866
  exports.deleteModel = deleteModel;
850
867
  /**
851
- * Get model
852
- * Returns a model by name.
868
+ * Get model endpoint
869
+ * Returns detailed information about a model gateway endpoint including its provider configuration, integration connection, and usage status.
853
870
  */
854
871
  const getModel = (options) => {
855
872
  return (options.client ?? client_gen_1.client).get({
@@ -865,8 +882,8 @@ const getModel = (options) => {
865
882
  };
866
883
  exports.getModel = getModel;
867
884
  /**
868
- * Create or update model
869
- * Update a model by name.
885
+ * Update model endpoint
886
+ * Updates a model gateway endpoint's configuration. Changes to provider settings or integration connection take effect immediately.
870
887
  */
871
888
  const updateModel = (options) => {
872
889
  return (options.client ?? client_gen_1.client).put({
@@ -903,8 +920,8 @@ const listModelRevisions = (options) => {
903
920
  };
904
921
  exports.listModelRevisions = listModelRevisions;
905
922
  /**
906
- * List policies
907
- * Returns a list of all policies in the workspace.
923
+ * List governance policies
924
+ * Returns all governance policies in the workspace. Policies control deployment locations, hardware flavors, and token limits for agents, functions, and models.
908
925
  */
909
926
  const listPolicies = (options) => {
910
927
  return (options?.client ?? client_gen_1.client).get({
@@ -920,8 +937,8 @@ const listPolicies = (options) => {
920
937
  };
921
938
  exports.listPolicies = listPolicies;
922
939
  /**
923
- * Create policy
924
- * Creates a policy.
940
+ * Create governance policy
941
+ * Creates a new governance policy to control where and how resources are deployed. Policies can restrict deployment to specific regions, countries, or continents for compliance.
925
942
  */
926
943
  const createPolicy = (options) => {
927
944
  return (options.client ?? client_gen_1.client).post({
@@ -941,8 +958,8 @@ const createPolicy = (options) => {
941
958
  };
942
959
  exports.createPolicy = createPolicy;
943
960
  /**
944
- * Delete policy
945
- * Deletes a policy by name.
961
+ * Delete governance policy
962
+ * Permanently deletes a governance policy. Resources using this policy will need to be updated to use a different policy.
946
963
  */
947
964
  const deletePolicy = (options) => {
948
965
  return (options.client ?? client_gen_1.client).delete({
@@ -958,8 +975,8 @@ const deletePolicy = (options) => {
958
975
  };
959
976
  exports.deletePolicy = deletePolicy;
960
977
  /**
961
- * Get policy
962
- * Returns a policy by name.
978
+ * Get governance policy
979
+ * Returns detailed information about a governance policy including its type (location, flavor, or maxToken), restrictions, and which resource types it applies to.
963
980
  */
964
981
  const getPolicy = (options) => {
965
982
  return (options.client ?? client_gen_1.client).get({
@@ -975,8 +992,8 @@ const getPolicy = (options) => {
975
992
  };
976
993
  exports.getPolicy = getPolicy;
977
994
  /**
978
- * Update policy
979
- * Updates a policy.
995
+ * Update governance policy
996
+ * Updates a governance policy's restrictions. Changes take effect on the next deployment of resources using this policy.
980
997
  */
981
998
  const updatePolicy = (options) => {
982
999
  return (options.client ?? client_gen_1.client).put({
@@ -1029,6 +1046,10 @@ const listPublicIps = (options) => {
1029
1046
  });
1030
1047
  };
1031
1048
  exports.listPublicIps = listPublicIps;
1049
+ /**
1050
+ * List Sandbox Hub templates
1051
+ * Returns all pre-built sandbox templates available in the Blaxel Hub. These include popular development environments with pre-installed tools and frameworks.
1052
+ */
1032
1053
  const listSandboxHubDefinitions = (options) => {
1033
1054
  return (options?.client ?? client_gen_1.client).get({
1034
1055
  security: [
@@ -1043,8 +1064,8 @@ const listSandboxHubDefinitions = (options) => {
1043
1064
  };
1044
1065
  exports.listSandboxHubDefinitions = listSandboxHubDefinitions;
1045
1066
  /**
1046
- * List Sandboxes
1047
- * Returns a list of all Sandboxes in the workspace.
1067
+ * List sandboxes
1068
+ * Returns all sandboxes in the workspace. Each sandbox includes its configuration, status, and endpoint URL.
1048
1069
  */
1049
1070
  const listSandboxes = (options) => {
1050
1071
  return (options?.client ?? client_gen_1.client).get({
@@ -1060,8 +1081,8 @@ const listSandboxes = (options) => {
1060
1081
  };
1061
1082
  exports.listSandboxes = listSandboxes;
1062
1083
  /**
1063
- * Create Sandbox
1064
- * Creates a Sandbox.
1084
+ * Create sandbox
1085
+ * Creates a new sandbox VM for secure AI code execution. Sandboxes automatically scale to zero when idle and resume instantly, preserving memory state including running processes and filesystem.
1065
1086
  */
1066
1087
  const createSandbox = (options) => {
1067
1088
  return (options.client ?? client_gen_1.client).post({
@@ -1081,8 +1102,8 @@ const createSandbox = (options) => {
1081
1102
  };
1082
1103
  exports.createSandbox = createSandbox;
1083
1104
  /**
1084
- * Delete Sandbox
1085
- * Deletes a Sandbox by name.
1105
+ * Delete sandbox
1106
+ * Permanently deletes a sandbox and all its data. If no volumes are attached, this guarantees zero data retention (ZDR). This action cannot be undone.
1086
1107
  */
1087
1108
  const deleteSandbox = (options) => {
1088
1109
  return (options.client ?? client_gen_1.client).delete({
@@ -1098,8 +1119,8 @@ const deleteSandbox = (options) => {
1098
1119
  };
1099
1120
  exports.deleteSandbox = deleteSandbox;
1100
1121
  /**
1101
- * Get Sandbox
1102
- * Returns a Sandbox by name.
1122
+ * Get sandbox
1123
+ * Returns detailed information about a sandbox including its configuration, attached volumes, lifecycle policies, and API endpoint URL.
1103
1124
  */
1104
1125
  const getSandbox = (options) => {
1105
1126
  return (options.client ?? client_gen_1.client).get({
@@ -1115,8 +1136,8 @@ const getSandbox = (options) => {
1115
1136
  };
1116
1137
  exports.getSandbox = getSandbox;
1117
1138
  /**
1118
- * Update Sandbox
1119
- * Update a Sandbox by name.
1139
+ * Update sandbox
1140
+ * Updates a sandbox's configuration. Note that certain changes (like image or memory) may reset the sandbox state. Use lifecycle policies to control automatic cleanup.
1120
1141
  */
1121
1142
  const updateSandbox = (options) => {
1122
1143
  return (options.client ?? client_gen_1.client).put({
@@ -1284,42 +1305,8 @@ const deleteSandboxPreviewToken = (options) => {
1284
1305
  };
1285
1306
  exports.deleteSandboxPreviewToken = deleteSandboxPreviewToken;
1286
1307
  /**
1287
- * Start Sandbox
1288
- * Starts a Sandbox by name.
1289
- */
1290
- const startSandbox = (options) => {
1291
- return (options.client ?? client_gen_1.client).put({
1292
- security: [
1293
- {
1294
- scheme: 'bearer',
1295
- type: 'http'
1296
- }
1297
- ],
1298
- url: '/sandboxes/{sandboxName}/start',
1299
- ...options
1300
- });
1301
- };
1302
- exports.startSandbox = startSandbox;
1303
- /**
1304
- * Stop Sandbox
1305
- * Stops a Sandbox by name.
1306
- */
1307
- const stopSandbox = (options) => {
1308
- return (options.client ?? client_gen_1.client).put({
1309
- security: [
1310
- {
1311
- scheme: 'bearer',
1312
- type: 'http'
1313
- }
1314
- ],
1315
- url: '/sandboxes/{sandboxName}/stop',
1316
- ...options
1317
- });
1318
- };
1319
- exports.stopSandbox = stopSandbox;
1320
- /**
1321
- * Get workspace service accounts
1322
- * Returns a list of all service accounts in the workspace.
1308
+ * List service accounts
1309
+ * Returns all service accounts in the workspace. Service accounts are machine identities for external systems to authenticate with Blaxel via OAuth or API keys.
1323
1310
  */
1324
1311
  const getWorkspaceServiceAccounts = (options) => {
1325
1312
  return (options?.client ?? client_gen_1.client).get({
@@ -1335,8 +1322,8 @@ const getWorkspaceServiceAccounts = (options) => {
1335
1322
  };
1336
1323
  exports.getWorkspaceServiceAccounts = getWorkspaceServiceAccounts;
1337
1324
  /**
1338
- * Create workspace service account
1339
- * Creates a service account in the workspace.
1325
+ * Create service account
1326
+ * Creates a new service account for machine-to-machine authentication. Returns client ID and secret (secret is only shown once at creation). Use these credentials for OAuth client_credentials flow.
1340
1327
  */
1341
1328
  const createWorkspaceServiceAccount = (options) => {
1342
1329
  return (options.client ?? client_gen_1.client).post({
@@ -1356,8 +1343,8 @@ const createWorkspaceServiceAccount = (options) => {
1356
1343
  };
1357
1344
  exports.createWorkspaceServiceAccount = createWorkspaceServiceAccount;
1358
1345
  /**
1359
- * Delete workspace service account
1360
- * Deletes a service account.
1346
+ * Delete service account
1347
+ * Permanently deletes a service account and invalidates all its credentials. Any systems using this service account will lose access immediately.
1361
1348
  */
1362
1349
  const deleteWorkspaceServiceAccount = (options) => {
1363
1350
  return (options.client ?? client_gen_1.client).delete({
@@ -1373,8 +1360,8 @@ const deleteWorkspaceServiceAccount = (options) => {
1373
1360
  };
1374
1361
  exports.deleteWorkspaceServiceAccount = deleteWorkspaceServiceAccount;
1375
1362
  /**
1376
- * Update workspace service account
1377
- * Updates a service account.
1363
+ * Update service account
1364
+ * Updates a service account's name or description. Credentials (client ID/secret) cannot be changed.
1378
1365
  */
1379
1366
  const updateWorkspaceServiceAccount = (options) => {
1380
1367
  return (options.client ?? client_gen_1.client).put({
@@ -1394,8 +1381,8 @@ const updateWorkspaceServiceAccount = (options) => {
1394
1381
  };
1395
1382
  exports.updateWorkspaceServiceAccount = updateWorkspaceServiceAccount;
1396
1383
  /**
1397
- * List API keys for service account
1398
- * Returns a list of all API keys for a service account.
1384
+ * List service account API keys
1385
+ * Returns all long-lived API keys created for a service account. API keys provide an alternative to OAuth for simpler authentication scenarios.
1399
1386
  */
1400
1387
  const listApiKeysForServiceAccount = (options) => {
1401
1388
  return (options.client ?? client_gen_1.client).get({
@@ -1411,8 +1398,8 @@ const listApiKeysForServiceAccount = (options) => {
1411
1398
  };
1412
1399
  exports.listApiKeysForServiceAccount = listApiKeysForServiceAccount;
1413
1400
  /**
1414
- * Create API key for service account
1415
- * Creates an API key for a service account.
1401
+ * Create service account API key
1402
+ * Creates a new long-lived API key for a service account. The full key value is only returned once at creation. API keys can have optional expiration dates.
1416
1403
  */
1417
1404
  const createApiKeyForServiceAccount = (options) => {
1418
1405
  return (options.client ?? client_gen_1.client).post({
@@ -1432,8 +1419,8 @@ const createApiKeyForServiceAccount = (options) => {
1432
1419
  };
1433
1420
  exports.createApiKeyForServiceAccount = createApiKeyForServiceAccount;
1434
1421
  /**
1435
- * Delete API key for service account
1436
- * Deletes an API key for a service account.
1422
+ * Revoke service account API key
1423
+ * Revokes an API key for a service account. The key becomes invalid immediately and any requests using it will fail authentication.
1437
1424
  */
1438
1425
  const deleteApiKeyForServiceAccount = (options) => {
1439
1426
  return (options.client ?? client_gen_1.client).delete({
@@ -1449,8 +1436,8 @@ const deleteApiKeyForServiceAccount = (options) => {
1449
1436
  };
1450
1437
  exports.deleteApiKeyForServiceAccount = deleteApiKeyForServiceAccount;
1451
1438
  /**
1452
- * List templates
1453
- * Returns a list of all templates.
1439
+ * List deployment templates
1440
+ * Returns all deployment templates available for creating agents, functions, and other resources with pre-configured settings and code.
1454
1441
  */
1455
1442
  const listTemplates = (options) => {
1456
1443
  return (options?.client ?? client_gen_1.client).get({
@@ -1467,7 +1454,7 @@ const listTemplates = (options) => {
1467
1454
  exports.listTemplates = listTemplates;
1468
1455
  /**
1469
1456
  * Get template
1470
- * Returns a template by name.
1457
+ * Returns detailed information about a deployment template including its configuration, source code reference, and available parameters.
1471
1458
  */
1472
1459
  const getTemplate = (options) => {
1473
1460
  return (options.client ?? client_gen_1.client).get({
@@ -1483,8 +1470,8 @@ const getTemplate = (options) => {
1483
1470
  };
1484
1471
  exports.getTemplate = getTemplate;
1485
1472
  /**
1486
- * List users in workspace
1487
- * Returns a list of all users in the workspace.
1473
+ * List workspace team members
1474
+ * Returns all team members in the workspace including their roles (admin or member) and invitation status.
1488
1475
  */
1489
1476
  const listWorkspaceUsers = (options) => {
1490
1477
  return (options?.client ?? client_gen_1.client).get({
@@ -1501,7 +1488,7 @@ const listWorkspaceUsers = (options) => {
1501
1488
  exports.listWorkspaceUsers = listWorkspaceUsers;
1502
1489
  /**
1503
1490
  * Invite user to workspace
1504
- * Invites a user to the workspace by email.
1491
+ * Invites a new team member to the workspace by email. The invitee will receive an email to accept the invitation before gaining access to workspace resources.
1505
1492
  */
1506
1493
  const inviteWorkspaceUser = (options) => {
1507
1494
  return (options.client ?? client_gen_1.client).post({
@@ -1560,7 +1547,7 @@ const updateWorkspaceUserRole = (options) => {
1560
1547
  exports.updateWorkspaceUserRole = updateWorkspaceUserRole;
1561
1548
  /**
1562
1549
  * List volume templates
1563
- * Returns a list of all volume templates.
1550
+ * Returns all volume templates in the workspace. Volume templates contain pre-configured filesystem snapshots that can be used to initialize new volumes.
1564
1551
  */
1565
1552
  const listVolumeTemplates = (options) => {
1566
1553
  return (options?.client ?? client_gen_1.client).get({
@@ -1577,7 +1564,7 @@ const listVolumeTemplates = (options) => {
1577
1564
  exports.listVolumeTemplates = listVolumeTemplates;
1578
1565
  /**
1579
1566
  * Create volume template
1580
- * Creates a volume template.
1567
+ * Creates a new volume template for initializing volumes with pre-configured filesystem contents. Optionally returns a presigned URL for uploading the template archive.
1581
1568
  */
1582
1569
  const createVolumeTemplate = (options) => {
1583
1570
  return (options.client ?? client_gen_1.client).post({
@@ -1669,8 +1656,8 @@ const deleteVolumeTemplateVersion = (options) => {
1669
1656
  };
1670
1657
  exports.deleteVolumeTemplateVersion = deleteVolumeTemplateVersion;
1671
1658
  /**
1672
- * List volumes
1673
- * Returns a list of all volumes in the workspace.
1659
+ * List persistent volumes
1660
+ * Returns all persistent storage volumes in the workspace. Volumes can be attached to sandboxes for durable file storage that persists across sessions and sandbox deletions.
1674
1661
  */
1675
1662
  const listVolumes = (options) => {
1676
1663
  return (options?.client ?? client_gen_1.client).get({
@@ -1686,8 +1673,8 @@ const listVolumes = (options) => {
1686
1673
  };
1687
1674
  exports.listVolumes = listVolumes;
1688
1675
  /**
1689
- * Create volume
1690
- * Creates a volume.
1676
+ * Create persistent volume
1677
+ * Creates a new persistent storage volume that can be attached to sandboxes. Volumes must be created in a specific region and can only attach to sandboxes in the same region.
1691
1678
  */
1692
1679
  const createVolume = (options) => {
1693
1680
  return (options.client ?? client_gen_1.client).post({
@@ -1707,8 +1694,8 @@ const createVolume = (options) => {
1707
1694
  };
1708
1695
  exports.createVolume = createVolume;
1709
1696
  /**
1710
- * Delete volume
1711
- * Deletes a volume by name.
1697
+ * Delete persistent volume
1698
+ * Permanently deletes a volume and all its data. The volume must not be attached to any sandbox. This action cannot be undone.
1712
1699
  */
1713
1700
  const deleteVolume = (options) => {
1714
1701
  return (options.client ?? client_gen_1.client).delete({
@@ -1724,8 +1711,8 @@ const deleteVolume = (options) => {
1724
1711
  };
1725
1712
  exports.deleteVolume = deleteVolume;
1726
1713
  /**
1727
- * Get volume
1728
- * Returns a volume by name.
1714
+ * Get persistent volume
1715
+ * Returns detailed information about a volume including its size, region, attachment status, and any events history.
1729
1716
  */
1730
1717
  const getVolume = (options) => {
1731
1718
  return (options.client ?? client_gen_1.client).get({
@@ -1741,8 +1728,8 @@ const getVolume = (options) => {
1741
1728
  };
1742
1729
  exports.getVolume = getVolume;
1743
1730
  /**
1744
- * List workspaces
1745
- * Returns a list of all workspaces.
1731
+ * List accessible workspaces
1732
+ * Returns all workspaces the authenticated user has access to. Each workspace is a separate tenant with its own resources, team members, and billing.
1746
1733
  */
1747
1734
  const listWorkspaces = (options) => {
1748
1735
  return (options?.client ?? client_gen_1.client).get({
@@ -1758,8 +1745,8 @@ const listWorkspaces = (options) => {
1758
1745
  };
1759
1746
  exports.listWorkspaces = listWorkspaces;
1760
1747
  /**
1761
- * Create worspace
1762
- * Creates a workspace.
1748
+ * Create workspace tenant
1749
+ * Creates a new workspace tenant. The authenticated user becomes the workspace admin. Requires a linked billing account.
1763
1750
  */
1764
1751
  const createWorkspace = (options) => {
1765
1752
  return (options.client ?? client_gen_1.client).post({
@@ -1779,8 +1766,8 @@ const createWorkspace = (options) => {
1779
1766
  };
1780
1767
  exports.createWorkspace = createWorkspace;
1781
1768
  /**
1782
- * Delete workspace
1783
- * Deletes a workspace by name.
1769
+ * Delete workspace tenant
1770
+ * Permanently deletes a workspace and ALL its resources (agents, functions, sandboxes, volumes, etc.). This action cannot be undone. Only workspace admins can delete a workspace.
1784
1771
  */
1785
1772
  const deleteWorkspace = (options) => {
1786
1773
  return (options.client ?? client_gen_1.client).delete({
@@ -1796,8 +1783,8 @@ const deleteWorkspace = (options) => {
1796
1783
  };
1797
1784
  exports.deleteWorkspace = deleteWorkspace;
1798
1785
  /**
1799
- * Get workspace
1800
- * Returns a workspace by name.
1786
+ * Get workspace details
1787
+ * Returns detailed information about a workspace including its display name, account ID, status, and runtime configuration.
1801
1788
  */
1802
1789
  const getWorkspace = (options) => {
1803
1790
  return (options.client ?? client_gen_1.client).get({
@@ -1814,7 +1801,7 @@ const getWorkspace = (options) => {
1814
1801
  exports.getWorkspace = getWorkspace;
1815
1802
  /**
1816
1803
  * Update workspace
1817
- * Updates a workspace by name.
1804
+ * Updates a workspace's settings such as display name and labels. The workspace name cannot be changed after creation.
1818
1805
  */
1819
1806
  const updateWorkspace = (options) => {
1820
1807
  return (options.client ?? client_gen_1.client).put({