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

package/dist/esm/client/sdk.gen.js

@@ -2,6 +2,7 @@
 import { client as _heyApiClient } from "./client.gen.js";
 /**
  * List all agents
+ * Returns all AI agents deployed in the workspace. Each agent includes its deployment status, runtime configuration, and global inference endpoint URL.
  */
 export const listAgents = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -16,7 +17,8 @@ export const listAgents = (options) => {
     });
 };
 /**
- * Create agent by name
+ * Create agent
+ * 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.
  */
 export const createAgent = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -35,7 +37,8 @@ export const createAgent = (options) => {
     });
 };
 /**
- * Delete agent by name
+ * Delete agent
+ * Permanently deletes an agent and all its deployment history. The agent's inference endpoint will immediately stop responding. This action cannot be undone.
  */
 export const deleteAgent = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -50,7 +53,8 @@ export const deleteAgent = (options) => {
     });
 };
 /**
- * Get agent by name
+ * Get agent
+ * Returns detailed information about an agent including its current deployment status, configuration, events history, and inference endpoint URL.
  */
 export const getAgent = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -65,7 +69,8 @@ export const getAgent = (options) => {
     });
 };
 /**
- * Update agent by name
+ * Update agent
+ * 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.
  */
 export const updateAgent = (options) => {
     return (options.client ?? _heyApiClient).put({
@@ -99,7 +104,8 @@ export const listAgentRevisions = (options) => {
     });
 };
 /**
- * List all configurations
+ * Get platform configuration
+ * Returns global platform configuration including available regions, countries, continents, and private locations for deployment policies.
  */
 export const getConfiguration = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -114,7 +120,8 @@ export const getConfiguration = (options) => {
     });
 };
 /**
- * List all custom domains
+ * List custom domains
+ * Returns all custom domains configured in the workspace. Custom domains allow serving preview deployments under your own domain (e.g., preview.yourdomain.com).
  */
 export const listCustomDomains = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -130,6 +137,7 @@ export const listCustomDomains = (options) => {
 };
 /**
  * Create custom domain
+ * Creates a new custom domain for preview deployments. After creation, you must configure DNS records and verify domain ownership before it becomes active.
  */
 export const createCustomDomain = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -212,7 +220,8 @@ export const verifyCustomDomain = (options) => {
     });
 };
 /**
- * List all functions
+ * List all MCP servers
+ * Returns all MCP server functions deployed in the workspace. Each function includes its deployment status, transport protocol (websocket or http-stream), and endpoint URL.
  */
 export const listFunctions = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -227,7 +236,8 @@ export const listFunctions = (options) => {
     });
 };
 /**
- * Create function
+ * Create MCP server
+ * 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.
  */
 export const createFunction = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -246,7 +256,8 @@ export const createFunction = (options) => {
     });
 };
 /**
- * Delete function by name
+ * Delete MCP server
+ * 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.
  */
 export const deleteFunction = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -261,7 +272,8 @@ export const deleteFunction = (options) => {
     });
 };
 /**
- * Get function by name
+ * Get MCP server
+ * Returns detailed information about an MCP server function including its deployment status, available tools, transport configuration, and endpoint URL.
  */
 export const getFunction = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -276,7 +288,8 @@ export const getFunction = (options) => {
     });
 };
 /**
- * Update function by name
+ * Update MCP server
+ * 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.
  */
 export const updateFunction = (options) => {
     return (options.client ?? _heyApiClient).put({
@@ -311,8 +324,8 @@ export const listFunctionRevisions = (options) => {
     });
 };
 /**
- * Cleanup unused images
- * Deletes all unused images in the workspace. Only removes images that are not currently being used by any agents, functions, sandboxes, or jobs.
+ * Cleanup unused container images
+ * 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.
  */
 export const cleanupImages = (options) => {
     return (options?.client ?? _heyApiClient).delete({
@@ -327,8 +340,8 @@ export const cleanupImages = (options) => {
     });
 };
 /**
- * List images
- * Returns a list of all images in the workspace grouped by repository with tags.
+ * List container images
+ * 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.
  */
 export const listImages = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -343,8 +356,8 @@ export const listImages = (options) => {
     });
 };
 /**
- * Delete image by name
- * Deletes an image by name.
+ * Delete container image
+ * 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.
  */
 export const deleteImage = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -359,8 +372,8 @@ export const deleteImage = (options) => {
     });
 };
 /**
- * Get image by name
- * Returns an image by name.
+ * Get container image
+ * Returns detailed information about a container image including all available tags, creation dates, and size information.
  */
 export const getImage = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -375,8 +388,8 @@ export const getImage = (options) => {
     });
 };
 /**
- * Delete image tag
- * Deletes a specific tag from an image.
+ * Delete container image tag
+ * 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.
  */
 export const deleteImageTag = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -391,8 +404,8 @@ export const deleteImageTag = (options) => {
     });
 };
 /**
- * List integrations connections
- * Returns integration information by name.
+ * Get integration provider info
+ * Returns metadata about an integration provider including available endpoints, authentication methods, and supported models or features.
  */
 export const getIntegration = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -407,8 +420,8 @@ export const getIntegration = (options) => {
     });
 };
 /**
- * List integrations connections
- * Returns a list of all connections integrations in the workspace.
+ * List integration connections
+ * Returns all configured integration connections in the workspace. Each connection stores credentials and settings for an external service (LLM provider, API, database).
  */
 export const listIntegrationConnections = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -423,8 +436,8 @@ export const listIntegrationConnections = (options) => {
     });
 };
 /**
- * Create integration
- * Create a connection for an integration.
+ * Create integration connection
+ * 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.
  */
 export const createIntegrationConnection = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -443,8 +456,8 @@ export const createIntegrationConnection = (options) => {
     });
 };
 /**
- * Delete integration
- * Deletes an integration connection by integration name and connection name.
+ * Delete integration connection
+ * Permanently deletes an integration connection. Any resources using this connection will lose access to the external service.
  */
 export const deleteIntegrationConnection = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -459,8 +472,8 @@ export const deleteIntegrationConnection = (options) => {
     });
 };
 /**
- * Get integration
- * Returns an integration connection by integration name and connection name.
+ * Get integration connection
+ * Returns detailed information about an integration connection including its provider type, configuration (secrets are masked), and usage status.
  */
 export const getIntegrationConnection = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -476,7 +489,7 @@ export const getIntegrationConnection = (options) => {
 };
 /**
  * Update integration connection
- * Update an integration connection by integration name and connection name.
+ * Updates an integration connection's configuration or credentials. Changes take effect immediately for all resources using this connection.
  */
 export const updateIntegrationConnection = (options) => {
     return (options.client ?? _heyApiClient).put({
@@ -527,7 +540,7 @@ export const listIntegrationConnectionModels = (options) => {
     });
 };
 /**
- * Get integration model endpoint configurations
+ * Get integration connection model
  * Returns a model for an integration connection by ID.
  */
 export const getIntegrationConnectionModel = (options) => {
@@ -543,8 +556,8 @@ export const getIntegrationConnectionModel = (options) => {
     });
 };
 /**
- * List jobs
- * Returns a list of all jobs in the workspace.
+ * List batch jobs
+ * Returns all batch job definitions in the workspace. Each job can be triggered to run multiple parallel tasks with configurable concurrency and retry settings.
  */
 export const listJobs = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -559,8 +572,8 @@ export const listJobs = (options) => {
     });
 };
 /**
- * Create job
- * Creates a job.
+ * Create batch job
+ * 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.
  */
 export const createJob = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -579,8 +592,8 @@ export const createJob = (options) => {
     });
 };
 /**
- * Delete job
- * Deletes a job by name.
+ * Delete batch job
+ * Permanently deletes a batch job definition and cancels any running executions. Historical execution data will be retained for a limited time.
  */
 export const deleteJob = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -595,8 +608,8 @@ export const deleteJob = (options) => {
     });
 };
 /**
- * Get job
- * Returns a job by name.
+ * Get batch job
+ * Returns detailed information about a batch job including its runtime configuration, execution history, and deployment status.
  */
 export const getJob = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -611,8 +624,8 @@ export const getJob = (options) => {
     });
 };
 /**
- * Create or update job
- * Update a job by name.
+ * Update batch job
+ * Updates a batch job's configuration. Changes affect new executions; running executions continue with their original configuration.
  */
 export const updateJob = (options) => {
     return (options.client ?? _heyApiClient).put({
@@ -632,7 +645,7 @@ export const updateJob = (options) => {
 };
 /**
  * List job executions
- * Returns a list of all executions for a job by name.
+ * Returns paginated list of executions for a batch job, sorted by creation time. Each execution contains status, task counts, and timing information.
  */
 export const listJobExecutions = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -648,7 +661,7 @@ export const listJobExecutions = (options) => {
 };
 /**
  * Create job execution
- * Creates a new execution for a job by name.
+ * 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.
  */
 export const createJobExecution = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -667,8 +680,8 @@ export const createJobExecution = (options) => {
     });
 };
 /**
- * Delete job execution
- * Stop an execution for a job by name.
+ * Cancel job execution
+ * 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'.
  */
 export const deleteJobExecution = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -684,7 +697,7 @@ export const deleteJobExecution = (options) => {
 };
 /**
  * Get job execution
- * Returns an execution for a job by name.
+ * Returns detailed information about a specific job execution including status, task statistics (success/failure/running counts), and timing information.
  */
 export const getJobExecution = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -715,8 +728,8 @@ export const listJobRevisions = (options) => {
     });
 };
 /**
- * List locations
- * Returns a list of all locations available with status.
+ * List deployment regions
+ * Returns all deployment regions with their current availability status and supported hardware flavors. Use this to discover where resources can be deployed.
  */
 export const listLocations = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -730,6 +743,10 @@ export const listLocations = (options) => {
         ...options
     });
 };
+/**
+ * List MCP Hub servers
+ * 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.
+ */
 export const listMcpHubDefinitions = (options) => {
     return (options?.client ?? _heyApiClient).get({
         security: [
@@ -743,8 +760,8 @@ export const listMcpHubDefinitions = (options) => {
     });
 };
 /**
- * List models
- * Returns a list of all models in the workspace.
+ * List model endpoints
+ * 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.
  */
 export const listModels = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -759,8 +776,8 @@ export const listModels = (options) => {
     });
 };
 /**
- * Create model
- * Creates a model.
+ * Create model endpoint
+ * 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.
  */
 export const createModel = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -779,8 +796,8 @@ export const createModel = (options) => {
     });
 };
 /**
- * Delete model
- * Deletes a model by name.
+ * Delete model endpoint
+ * Permanently deletes a model gateway endpoint. Any agents or applications using this endpoint will need to be updated to use a different model.
  */
 export const deleteModel = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -795,8 +812,8 @@ export const deleteModel = (options) => {
     });
 };
 /**
- * Get model
- * Returns a model by name.
+ * Get model endpoint
+ * Returns detailed information about a model gateway endpoint including its provider configuration, integration connection, and usage status.
  */
 export const getModel = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -811,8 +828,8 @@ export const getModel = (options) => {
     });
 };
 /**
- * Create or update model
- * Update a model by name.
+ * Update model endpoint
+ * Updates a model gateway endpoint's configuration. Changes to provider settings or integration connection take effect immediately.
  */
 export const updateModel = (options) => {
     return (options.client ?? _heyApiClient).put({
@@ -847,8 +864,8 @@ export const listModelRevisions = (options) => {
     });
 };
 /**
- * List policies
- * Returns a list of all policies in the workspace.
+ * List governance policies
+ * Returns all governance policies in the workspace. Policies control deployment locations, hardware flavors, and token limits for agents, functions, and models.
  */
 export const listPolicies = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -863,8 +880,8 @@ export const listPolicies = (options) => {
     });
 };
 /**
- * Create policy
- * Creates a policy.
+ * Create governance policy
+ * 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.
  */
 export const createPolicy = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -883,8 +900,8 @@ export const createPolicy = (options) => {
     });
 };
 /**
- * Delete policy
- * Deletes a policy by name.
+ * Delete governance policy
+ * Permanently deletes a governance policy. Resources using this policy will need to be updated to use a different policy.
  */
 export const deletePolicy = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -899,8 +916,8 @@ export const deletePolicy = (options) => {
     });
 };
 /**
- * Get policy
- * Returns a policy by name.
+ * Get governance policy
+ * Returns detailed information about a governance policy including its type (location, flavor, or maxToken), restrictions, and which resource types it applies to.
  */
 export const getPolicy = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -915,8 +932,8 @@ export const getPolicy = (options) => {
     });
 };
 /**
- * Update policy
- * Updates a policy.
+ * Update governance policy
+ * Updates a governance policy's restrictions. Changes take effect on the next deployment of resources using this policy.
  */
 export const updatePolicy = (options) => {
     return (options.client ?? _heyApiClient).put({
@@ -966,6 +983,10 @@ export const listPublicIps = (options) => {
         ...options
     });
 };
+/**
+ * List Sandbox Hub templates
+ * Returns all pre-built sandbox templates available in the Blaxel Hub. These include popular development environments with pre-installed tools and frameworks.
+ */
 export const listSandboxHubDefinitions = (options) => {
     return (options?.client ?? _heyApiClient).get({
         security: [
@@ -979,8 +1000,8 @@ export const listSandboxHubDefinitions = (options) => {
     });
 };
 /**
- * List Sandboxes
- * Returns a list of all Sandboxes in the workspace.
+ * List sandboxes
+ * Returns all sandboxes in the workspace. Each sandbox includes its configuration, status, and endpoint URL.
  */
 export const listSandboxes = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -995,8 +1016,8 @@ export const listSandboxes = (options) => {
     });
 };
 /**
- * Create Sandbox
- * Creates a Sandbox.
+ * Create sandbox
+ * 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.
  */
 export const createSandbox = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -1015,8 +1036,8 @@ export const createSandbox = (options) => {
     });
 };
 /**
- * Delete Sandbox
- * Deletes a Sandbox by name.
+ * Delete sandbox
+ * Permanently deletes a sandbox and all its data. If no volumes are attached, this guarantees zero data retention (ZDR). This action cannot be undone.
  */
 export const deleteSandbox = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -1031,8 +1052,8 @@ export const deleteSandbox = (options) => {
     });
 };
 /**
- * Get Sandbox
- * Returns a Sandbox by name.
+ * Get sandbox
+ * Returns detailed information about a sandbox including its configuration, attached volumes, lifecycle policies, and API endpoint URL.
  */
 export const getSandbox = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -1047,8 +1068,8 @@ export const getSandbox = (options) => {
     });
 };
 /**
- * Update Sandbox
- * Update a Sandbox by name.
+ * Update sandbox
+ * 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.
  */
 export const updateSandbox = (options) => {
     return (options.client ?? _heyApiClient).put({
@@ -1207,40 +1228,8 @@ export const deleteSandboxPreviewToken = (options) => {
     });
 };
 /**
- * Start Sandbox
- * Starts a Sandbox by name.
- */
-export const startSandbox = (options) => {
-    return (options.client ?? _heyApiClient).put({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/sandboxes/{sandboxName}/start',
-        ...options
-    });
-};
-/**
- * Stop Sandbox
- * Stops a Sandbox by name.
- */
-export const stopSandbox = (options) => {
-    return (options.client ?? _heyApiClient).put({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/sandboxes/{sandboxName}/stop',
-        ...options
-    });
-};
-/**
- * Get workspace service accounts
- * Returns a list of all service accounts in the workspace.
+ * List service accounts
+ * Returns all service accounts in the workspace. Service accounts are machine identities for external systems to authenticate with Blaxel via OAuth or API keys.
  */
 export const getWorkspaceServiceAccounts = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -1255,8 +1244,8 @@ export const getWorkspaceServiceAccounts = (options) => {
     });
 };
 /**
- * Create workspace service account
- * Creates a service account in the workspace.
+ * Create service account
+ * 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.
  */
 export const createWorkspaceServiceAccount = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -1275,8 +1264,8 @@ export const createWorkspaceServiceAccount = (options) => {
     });
 };
 /**
- * Delete workspace service account
- * Deletes a service account.
+ * Delete service account
+ * Permanently deletes a service account and invalidates all its credentials. Any systems using this service account will lose access immediately.
  */
 export const deleteWorkspaceServiceAccount = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -1291,8 +1280,8 @@ export const deleteWorkspaceServiceAccount = (options) => {
     });
 };
 /**
- * Update workspace service account
- * Updates a service account.
+ * Update service account
+ * Updates a service account's name or description. Credentials (client ID/secret) cannot be changed.
  */
 export const updateWorkspaceServiceAccount = (options) => {
     return (options.client ?? _heyApiClient).put({
@@ -1311,8 +1300,8 @@ export const updateWorkspaceServiceAccount = (options) => {
     });
 };
 /**
- * List API keys for service account
- * Returns a list of all API keys for a service account.
+ * List service account API keys
+ * Returns all long-lived API keys created for a service account. API keys provide an alternative to OAuth for simpler authentication scenarios.
  */
 export const listApiKeysForServiceAccount = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -1327,8 +1316,8 @@ export const listApiKeysForServiceAccount = (options) => {
     });
 };
 /**
- * Create API key for service account
- * Creates an API key for a service account.
+ * Create service account API key
+ * 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.
  */
 export const createApiKeyForServiceAccount = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -1347,8 +1336,8 @@ export const createApiKeyForServiceAccount = (options) => {
     });
 };
 /**
- * Delete API key for service account
- * Deletes an API key for a service account.
+ * Revoke service account API key
+ * Revokes an API key for a service account. The key becomes invalid immediately and any requests using it will fail authentication.
  */
 export const deleteApiKeyForServiceAccount = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -1363,8 +1352,8 @@ export const deleteApiKeyForServiceAccount = (options) => {
     });
 };
 /**
- * List templates
- * Returns a list of all templates.
+ * List deployment templates
+ * Returns all deployment templates available for creating agents, functions, and other resources with pre-configured settings and code.
  */
 export const listTemplates = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -1380,7 +1369,7 @@ export const listTemplates = (options) => {
 };
 /**
  * Get template
- * Returns a template by name.
+ * Returns detailed information about a deployment template including its configuration, source code reference, and available parameters.
  */
 export const getTemplate = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -1395,8 +1384,8 @@ export const getTemplate = (options) => {
     });
 };
 /**
- * List users in workspace
- * Returns a list of all users in the workspace.
+ * List workspace team members
+ * Returns all team members in the workspace including their roles (admin or member) and invitation status.
  */
 export const listWorkspaceUsers = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -1412,7 +1401,7 @@ export const listWorkspaceUsers = (options) => {
 };
 /**
  * Invite user to workspace
- * Invites a user to the workspace by email.
+ * 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.
  */
 export const inviteWorkspaceUser = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -1468,7 +1457,7 @@ export const updateWorkspaceUserRole = (options) => {
 };
 /**
  * List volume templates
- * Returns a list of all volume templates.
+ * Returns all volume templates in the workspace. Volume templates contain pre-configured filesystem snapshots that can be used to initialize new volumes.
  */
 export const listVolumeTemplates = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -1484,7 +1473,7 @@ export const listVolumeTemplates = (options) => {
 };
 /**
  * Create volume template
- * Creates a volume template.
+ * Creates a new volume template for initializing volumes with pre-configured filesystem contents. Optionally returns a presigned URL for uploading the template archive.
  */
 export const createVolumeTemplate = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -1571,8 +1560,8 @@ export const deleteVolumeTemplateVersion = (options) => {
     });
 };
 /**
- * List volumes
- * Returns a list of all volumes in the workspace.
+ * List persistent volumes
+ * 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.
  */
 export const listVolumes = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -1587,8 +1576,8 @@ export const listVolumes = (options) => {
     });
 };
 /**
- * Create volume
- * Creates a volume.
+ * Create persistent volume
+ * 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.
  */
 export const createVolume = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -1607,8 +1596,8 @@ export const createVolume = (options) => {
     });
 };
 /**
- * Delete volume
- * Deletes a volume by name.
+ * Delete persistent volume
+ * Permanently deletes a volume and all its data. The volume must not be attached to any sandbox. This action cannot be undone.
  */
 export const deleteVolume = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -1623,8 +1612,8 @@ export const deleteVolume = (options) => {
     });
 };
 /**
- * Get volume
- * Returns a volume by name.
+ * Get persistent volume
+ * Returns detailed information about a volume including its size, region, attachment status, and any events history.
  */
 export const getVolume = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -1639,8 +1628,8 @@ export const getVolume = (options) => {
     });
 };
 /**
- * List workspaces
- * Returns a list of all workspaces.
+ * List accessible workspaces
+ * Returns all workspaces the authenticated user has access to. Each workspace is a separate tenant with its own resources, team members, and billing.
  */
 export const listWorkspaces = (options) => {
     return (options?.client ?? _heyApiClient).get({
@@ -1655,8 +1644,8 @@ export const listWorkspaces = (options) => {
     });
 };
 /**
- * Create worspace
- * Creates a workspace.
+ * Create workspace tenant
+ * Creates a new workspace tenant. The authenticated user becomes the workspace admin. Requires a linked billing account.
  */
 export const createWorkspace = (options) => {
     return (options.client ?? _heyApiClient).post({
@@ -1675,8 +1664,8 @@ export const createWorkspace = (options) => {
     });
 };
 /**
- * Delete workspace
- * Deletes a workspace by name.
+ * Delete workspace tenant
+ * 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.
  */
 export const deleteWorkspace = (options) => {
     return (options.client ?? _heyApiClient).delete({
@@ -1691,8 +1680,8 @@ export const deleteWorkspace = (options) => {
     });
 };
 /**
- * Get workspace
- * Returns a workspace by name.
+ * Get workspace details
+ * Returns detailed information about a workspace including its display name, account ID, status, and runtime configuration.
  */
 export const getWorkspace = (options) => {
     return (options.client ?? _heyApiClient).get({
@@ -1708,7 +1697,7 @@ export const getWorkspace = (options) => {
 };
 /**
  * Update workspace
- * Updates a workspace by name.
+ * Updates a workspace's settings such as display name and labels. The workspace name cannot be changed after creation.
  */
 export const updateWorkspace = (options) => {
     return (options.client ?? _heyApiClient).put({