@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
@@ -1,5 +1,5 @@
1
1
  import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
2
- import type { ListAgentsData, CreateAgentData, DeleteAgentData, GetAgentData, UpdateAgentData, ListAgentRevisionsData, GetConfigurationData, ListCustomDomainsData, CreateCustomDomainData, DeleteCustomDomainData, GetCustomDomainData, UpdateCustomDomainData, VerifyCustomDomainData, ListFunctionsData, CreateFunctionData, DeleteFunctionData, GetFunctionData, UpdateFunctionData, ListFunctionRevisionsData, CleanupImagesData, ListImagesData, DeleteImageData, GetImageData, DeleteImageTagData, GetIntegrationData, ListIntegrationConnectionsData, CreateIntegrationConnectionData, DeleteIntegrationConnectionData, GetIntegrationConnectionData, UpdateIntegrationConnectionData, GetIntegrationConnectionModelEndpointConfigurationsData, ListIntegrationConnectionModelsData, GetIntegrationConnectionModelData, ListJobsData, CreateJobData, DeleteJobData, GetJobData, UpdateJobData, ListJobExecutionsData, CreateJobExecutionData, DeleteJobExecutionData, GetJobExecutionData, ListJobRevisionsData, ListLocationsData, ListMcpHubDefinitionsData, ListModelsData, CreateModelData, DeleteModelData, GetModelData, UpdateModelData, ListModelRevisionsData, ListPoliciesData, CreatePolicyData, DeletePolicyData, GetPolicyData, UpdatePolicyData, ListAllPendingInvitationsData, ListPublicIpsData, ListSandboxHubDefinitionsData, ListSandboxesData, CreateSandboxData, DeleteSandboxData, GetSandboxData, UpdateSandboxData, ListSandboxPreviewsData, CreateSandboxPreviewData, DeleteSandboxPreviewData, GetSandboxPreviewData, UpdateSandboxPreviewData, ListSandboxPreviewTokensData, CreateSandboxPreviewTokenData, DeleteSandboxPreviewTokenData, StartSandboxData, StopSandboxData, GetWorkspaceServiceAccountsData, CreateWorkspaceServiceAccountData, DeleteWorkspaceServiceAccountData, UpdateWorkspaceServiceAccountData, ListApiKeysForServiceAccountData, CreateApiKeyForServiceAccountData, DeleteApiKeyForServiceAccountData, ListTemplatesData, GetTemplateData, ListWorkspaceUsersData, InviteWorkspaceUserData, RemoveWorkspaceUserData, UpdateWorkspaceUserRoleData, ListVolumeTemplatesData, CreateVolumeTemplateData, DeleteVolumeTemplateData, GetVolumeTemplateData, UpdateVolumeTemplateData, DeleteVolumeTemplateVersionData, ListVolumesData, CreateVolumeData, DeleteVolumeData, GetVolumeData, ListWorkspacesData, CreateWorkspaceData, DeleteWorkspaceData, GetWorkspaceData, UpdateWorkspaceData, DeclineWorkspaceInvitationData, AcceptWorkspaceInvitationData, LeaveWorkspaceData, CheckWorkspaceAvailabilityData } from './types.gen.js';
2
+ import type { ListAgentsData, CreateAgentData, DeleteAgentData, GetAgentData, UpdateAgentData, ListAgentRevisionsData, GetConfigurationData, ListCustomDomainsData, CreateCustomDomainData, DeleteCustomDomainData, GetCustomDomainData, UpdateCustomDomainData, VerifyCustomDomainData, ListFunctionsData, CreateFunctionData, DeleteFunctionData, GetFunctionData, UpdateFunctionData, ListFunctionRevisionsData, CleanupImagesData, ListImagesData, DeleteImageData, GetImageData, DeleteImageTagData, GetIntegrationData, ListIntegrationConnectionsData, CreateIntegrationConnectionData, DeleteIntegrationConnectionData, GetIntegrationConnectionData, UpdateIntegrationConnectionData, GetIntegrationConnectionModelEndpointConfigurationsData, ListIntegrationConnectionModelsData, GetIntegrationConnectionModelData, ListJobsData, CreateJobData, DeleteJobData, GetJobData, UpdateJobData, ListJobExecutionsData, CreateJobExecutionData, DeleteJobExecutionData, GetJobExecutionData, ListJobRevisionsData, ListLocationsData, ListMcpHubDefinitionsData, ListModelsData, CreateModelData, DeleteModelData, GetModelData, UpdateModelData, ListModelRevisionsData, ListPoliciesData, CreatePolicyData, DeletePolicyData, GetPolicyData, UpdatePolicyData, ListAllPendingInvitationsData, ListPublicIpsData, ListSandboxHubDefinitionsData, ListSandboxesData, CreateSandboxData, DeleteSandboxData, GetSandboxData, UpdateSandboxData, ListSandboxPreviewsData, CreateSandboxPreviewData, DeleteSandboxPreviewData, GetSandboxPreviewData, UpdateSandboxPreviewData, ListSandboxPreviewTokensData, CreateSandboxPreviewTokenData, DeleteSandboxPreviewTokenData, GetWorkspaceServiceAccountsData, CreateWorkspaceServiceAccountData, DeleteWorkspaceServiceAccountData, UpdateWorkspaceServiceAccountData, ListApiKeysForServiceAccountData, CreateApiKeyForServiceAccountData, DeleteApiKeyForServiceAccountData, ListTemplatesData, GetTemplateData, ListWorkspaceUsersData, InviteWorkspaceUserData, RemoveWorkspaceUserData, UpdateWorkspaceUserRoleData, ListVolumeTemplatesData, CreateVolumeTemplateData, DeleteVolumeTemplateData, GetVolumeTemplateData, UpdateVolumeTemplateData, DeleteVolumeTemplateVersionData, ListVolumesData, CreateVolumeData, DeleteVolumeData, GetVolumeData, ListWorkspacesData, CreateWorkspaceData, DeleteWorkspaceData, GetWorkspaceData, UpdateWorkspaceData, DeclineWorkspaceInvitationData, AcceptWorkspaceInvitationData, LeaveWorkspaceData, CheckWorkspaceAvailabilityData } from './types.gen.js';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -15,38 +15,46 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
15
15
  };
16
16
  /**
17
17
  * List all agents
18
+ * Returns all AI agents deployed in the workspace. Each agent includes its deployment status, runtime configuration, and global inference endpoint URL.
18
19
  */
19
- export declare const listAgents: <ThrowOnError extends boolean = false>(options?: Options<ListAgentsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent[], unknown, ThrowOnError>;
20
+ export declare const listAgents: <ThrowOnError extends boolean = false>(options?: Options<ListAgentsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent[], import("./types.gen.js")._Error, ThrowOnError>;
20
21
  /**
21
- * Create agent by name
22
+ * Create agent
23
+ * 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.
22
24
  */
23
- export declare const createAgent: <ThrowOnError extends boolean = false>(options: Options<CreateAgentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent, unknown, ThrowOnError>;
25
+ export declare const createAgent: <ThrowOnError extends boolean = false>(options: Options<CreateAgentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent, import("./types.gen.js")._Error, ThrowOnError>;
24
26
  /**
25
- * Delete agent by name
27
+ * Delete agent
28
+ * Permanently deletes an agent and all its deployment history. The agent's inference endpoint will immediately stop responding. This action cannot be undone.
26
29
  */
27
- export declare const deleteAgent: <ThrowOnError extends boolean = false>(options: Options<DeleteAgentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent, unknown, ThrowOnError>;
30
+ export declare const deleteAgent: <ThrowOnError extends boolean = false>(options: Options<DeleteAgentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent, import("./types.gen.js")._Error, ThrowOnError>;
28
31
  /**
29
- * Get agent by name
32
+ * Get agent
33
+ * Returns detailed information about an agent including its current deployment status, configuration, events history, and inference endpoint URL.
30
34
  */
31
- export declare const getAgent: <ThrowOnError extends boolean = false>(options: Options<GetAgentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent, unknown, ThrowOnError>;
35
+ export declare const getAgent: <ThrowOnError extends boolean = false>(options: Options<GetAgentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent, import("./types.gen.js")._Error, ThrowOnError>;
32
36
  /**
33
- * Update agent by name
37
+ * Update agent
38
+ * 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.
34
39
  */
35
- export declare const updateAgent: <ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent, unknown, ThrowOnError>;
40
+ export declare const updateAgent: <ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Agent, import("./types.gen.js")._Error, ThrowOnError>;
36
41
  /**
37
42
  * List all agent revisions
38
43
  */
39
44
  export declare const listAgentRevisions: <ThrowOnError extends boolean = false>(options: Options<ListAgentRevisionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").RevisionMetadata[], unknown, ThrowOnError>;
40
45
  /**
41
- * List all configurations
46
+ * Get platform configuration
47
+ * Returns global platform configuration including available regions, countries, continents, and private locations for deployment policies.
42
48
  */
43
49
  export declare const getConfiguration: <ThrowOnError extends boolean = false>(options?: Options<GetConfigurationData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Configuration, unknown, ThrowOnError>;
44
50
  /**
45
- * List all custom domains
51
+ * List custom domains
52
+ * Returns all custom domains configured in the workspace. Custom domains allow serving preview deployments under your own domain (e.g., preview.yourdomain.com).
46
53
  */
47
54
  export declare const listCustomDomains: <ThrowOnError extends boolean = false>(options?: Options<ListCustomDomainsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").CustomDomain[], unknown, ThrowOnError>;
48
55
  /**
49
56
  * Create custom domain
57
+ * Creates a new custom domain for preview deployments. After creation, you must configure DNS records and verify domain ownership before it becomes active.
50
58
  */
51
59
  export declare const createCustomDomain: <ThrowOnError extends boolean = false>(options: Options<CreateCustomDomainData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").CustomDomain, unknown, ThrowOnError>;
52
60
  /**
@@ -66,88 +74,93 @@ export declare const updateCustomDomain: <ThrowOnError extends boolean = false>(
66
74
  */
67
75
  export declare const verifyCustomDomain: <ThrowOnError extends boolean = false>(options: Options<VerifyCustomDomainData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").CustomDomain, unknown, ThrowOnError>;
68
76
  /**
69
- * List all functions
77
+ * List all MCP servers
78
+ * Returns all MCP server functions deployed in the workspace. Each function includes its deployment status, transport protocol (websocket or http-stream), and endpoint URL.
70
79
  */
71
- export declare const listFunctions: <ThrowOnError extends boolean = false>(options?: Options<ListFunctionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function[], unknown, ThrowOnError>;
80
+ export declare const listFunctions: <ThrowOnError extends boolean = false>(options?: Options<ListFunctionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function[], import("./types.gen.js")._Error, ThrowOnError>;
72
81
  /**
73
- * Create function
82
+ * Create MCP server
83
+ * 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.
74
84
  */
75
- export declare const createFunction: <ThrowOnError extends boolean = false>(options: Options<CreateFunctionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function, unknown, ThrowOnError>;
85
+ export declare const createFunction: <ThrowOnError extends boolean = false>(options: Options<CreateFunctionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function, import("./types.gen.js")._Error, ThrowOnError>;
76
86
  /**
77
- * Delete function by name
87
+ * Delete MCP server
88
+ * 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.
78
89
  */
79
- export declare const deleteFunction: <ThrowOnError extends boolean = false>(options: Options<DeleteFunctionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function, unknown, ThrowOnError>;
90
+ export declare const deleteFunction: <ThrowOnError extends boolean = false>(options: Options<DeleteFunctionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function, import("./types.gen.js")._Error, ThrowOnError>;
80
91
  /**
81
- * Get function by name
92
+ * Get MCP server
93
+ * Returns detailed information about an MCP server function including its deployment status, available tools, transport configuration, and endpoint URL.
82
94
  */
83
- export declare const getFunction: <ThrowOnError extends boolean = false>(options: Options<GetFunctionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function, unknown, ThrowOnError>;
95
+ export declare const getFunction: <ThrowOnError extends boolean = false>(options: Options<GetFunctionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function, import("./types.gen.js")._Error, ThrowOnError>;
84
96
  /**
85
- * Update function by name
97
+ * Update MCP server
98
+ * 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.
86
99
  */
87
- export declare const updateFunction: <ThrowOnError extends boolean = false>(options: Options<UpdateFunctionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function, unknown, ThrowOnError>;
100
+ export declare const updateFunction: <ThrowOnError extends boolean = false>(options: Options<UpdateFunctionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js")._Function, import("./types.gen.js")._Error, ThrowOnError>;
88
101
  /**
89
102
  * List function revisions
90
103
  * Returns revisions for a function by name.
91
104
  */
92
105
  export declare const listFunctionRevisions: <ThrowOnError extends boolean = false>(options: Options<ListFunctionRevisionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").RevisionMetadata[], unknown, ThrowOnError>;
93
106
  /**
94
- * Cleanup unused images
95
- * Deletes all unused images in the workspace. Only removes images that are not currently being used by any agents, functions, sandboxes, or jobs.
107
+ * Cleanup unused container images
108
+ * 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.
96
109
  */
97
110
  export declare const cleanupImages: <ThrowOnError extends boolean = false>(options?: Options<CleanupImagesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
98
111
  deleted?: number;
99
112
  message?: string;
100
113
  }, unknown, ThrowOnError>;
101
114
  /**
102
- * List images
103
- * Returns a list of all images in the workspace grouped by repository with tags.
115
+ * List container images
116
+ * 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.
104
117
  */
105
118
  export declare const listImages: <ThrowOnError extends boolean = false>(options?: Options<ListImagesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Image[], unknown, ThrowOnError>;
106
119
  /**
107
- * Delete image by name
108
- * Deletes an image by name.
120
+ * Delete container image
121
+ * 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.
109
122
  */
110
123
  export declare const deleteImage: <ThrowOnError extends boolean = false>(options: Options<DeleteImageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Image, unknown, ThrowOnError>;
111
124
  /**
112
- * Get image by name
113
- * Returns an image by name.
125
+ * Get container image
126
+ * Returns detailed information about a container image including all available tags, creation dates, and size information.
114
127
  */
115
128
  export declare const getImage: <ThrowOnError extends boolean = false>(options: Options<GetImageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Image, unknown, ThrowOnError>;
116
129
  /**
117
- * Delete image tag
118
- * Deletes a specific tag from an image.
130
+ * Delete container image tag
131
+ * 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.
119
132
  */
120
133
  export declare const deleteImageTag: <ThrowOnError extends boolean = false>(options: Options<DeleteImageTagData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Image, unknown, ThrowOnError>;
121
134
  /**
122
- * List integrations connections
123
- * Returns integration information by name.
135
+ * Get integration provider info
136
+ * Returns metadata about an integration provider including available endpoints, authentication methods, and supported models or features.
124
137
  */
125
138
  export declare const getIntegration: <ThrowOnError extends boolean = false>(options: Options<GetIntegrationData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Integration, unknown, ThrowOnError>;
126
139
  /**
127
- * List integrations connections
128
- * Returns a list of all connections integrations in the workspace.
140
+ * List integration connections
141
+ * Returns all configured integration connections in the workspace. Each connection stores credentials and settings for an external service (LLM provider, API, database).
129
142
  */
130
- export declare const listIntegrationConnections: <ThrowOnError extends boolean = false>(options?: Options<ListIntegrationConnectionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection[], unknown, ThrowOnError>;
143
+ export declare const listIntegrationConnections: <ThrowOnError extends boolean = false>(options?: Options<ListIntegrationConnectionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection[], import("./types.gen.js")._Error, ThrowOnError>;
131
144
  /**
132
- * Create integration
133
- * Create a connection for an integration.
145
+ * Create integration connection
146
+ * 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.
134
147
  */
135
- export declare const createIntegrationConnection: <ThrowOnError extends boolean = false>(options: Options<CreateIntegrationConnectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection, unknown, ThrowOnError>;
148
+ export declare const createIntegrationConnection: <ThrowOnError extends boolean = false>(options: Options<CreateIntegrationConnectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection, import("./types.gen.js")._Error, ThrowOnError>;
136
149
  /**
137
- * Delete integration
138
- * Deletes an integration connection by integration name and connection name.
150
+ * Delete integration connection
151
+ * Permanently deletes an integration connection. Any resources using this connection will lose access to the external service.
139
152
  */
140
- export declare const deleteIntegrationConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteIntegrationConnectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection, unknown, ThrowOnError>;
153
+ export declare const deleteIntegrationConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteIntegrationConnectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection, import("./types.gen.js")._Error, ThrowOnError>;
141
154
  /**
142
- * Get integration
143
- * Returns an integration connection by integration name and connection name.
155
+ * Get integration connection
156
+ * Returns detailed information about an integration connection including its provider type, configuration (secrets are masked), and usage status.
144
157
  */
145
- export declare const getIntegrationConnection: <ThrowOnError extends boolean = false>(options: Options<GetIntegrationConnectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection, unknown, ThrowOnError>;
158
+ export declare const getIntegrationConnection: <ThrowOnError extends boolean = false>(options: Options<GetIntegrationConnectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection, import("./types.gen.js")._Error, ThrowOnError>;
146
159
  /**
147
160
  * Update integration connection
148
- * Update an integration connection by integration name and connection name.
161
+ * Updates an integration connection's configuration or credentials. Changes take effect immediately for all resources using this connection.
149
162
  */
150
- export declare const updateIntegrationConnection: <ThrowOnError extends boolean = false>(options: Options<UpdateIntegrationConnectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection, unknown, ThrowOnError>;
163
+ export declare const updateIntegrationConnection: <ThrowOnError extends boolean = false>(options: Options<UpdateIntegrationConnectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").IntegrationConnection, import("./types.gen.js")._Error, ThrowOnError>;
151
164
  /**
152
165
  * Get integration connection model endpoint configurations
153
166
  * Returns a list of all endpoint configurations for a model.
@@ -159,53 +172,53 @@ export declare const getIntegrationConnectionModelEndpointConfigurations: <Throw
159
172
  */
160
173
  export declare const listIntegrationConnectionModels: <ThrowOnError extends boolean = false>(options: Options<ListIntegrationConnectionModelsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
161
174
  /**
162
- * Get integration model endpoint configurations
175
+ * Get integration connection model
163
176
  * Returns a model for an integration connection by ID.
164
177
  */
165
178
  export declare const getIntegrationConnectionModel: <ThrowOnError extends boolean = false>(options: Options<GetIntegrationConnectionModelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
166
179
  /**
167
- * List jobs
168
- * Returns a list of all jobs in the workspace.
180
+ * List batch jobs
181
+ * Returns all batch job definitions in the workspace. Each job can be triggered to run multiple parallel tasks with configurable concurrency and retry settings.
169
182
  */
170
183
  export declare const listJobs: <ThrowOnError extends boolean = false>(options?: Options<ListJobsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Job[], unknown, ThrowOnError>;
171
184
  /**
172
- * Create job
173
- * Creates a job.
185
+ * Create batch job
186
+ * 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.
174
187
  */
175
188
  export declare const createJob: <ThrowOnError extends boolean = false>(options: Options<CreateJobData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Job, unknown, ThrowOnError>;
176
189
  /**
177
- * Delete job
178
- * Deletes a job by name.
190
+ * Delete batch job
191
+ * Permanently deletes a batch job definition and cancels any running executions. Historical execution data will be retained for a limited time.
179
192
  */
180
193
  export declare const deleteJob: <ThrowOnError extends boolean = false>(options: Options<DeleteJobData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Job, unknown, ThrowOnError>;
181
194
  /**
182
- * Get job
183
- * Returns a job by name.
195
+ * Get batch job
196
+ * Returns detailed information about a batch job including its runtime configuration, execution history, and deployment status.
184
197
  */
185
- export declare const getJob: <ThrowOnError extends boolean = false>(options: Options<GetJobData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model, unknown, ThrowOnError>;
198
+ export declare const getJob: <ThrowOnError extends boolean = false>(options: Options<GetJobData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Job, unknown, ThrowOnError>;
186
199
  /**
187
- * Create or update job
188
- * Update a job by name.
200
+ * Update batch job
201
+ * Updates a batch job's configuration. Changes affect new executions; running executions continue with their original configuration.
189
202
  */
190
203
  export declare const updateJob: <ThrowOnError extends boolean = false>(options: Options<UpdateJobData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Job, unknown, ThrowOnError>;
191
204
  /**
192
205
  * List job executions
193
- * Returns a list of all executions for a job by name.
206
+ * Returns paginated list of executions for a batch job, sorted by creation time. Each execution contains status, task counts, and timing information.
194
207
  */
195
208
  export declare const listJobExecutions: <ThrowOnError extends boolean = false>(options: Options<ListJobExecutionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").JobExecution[], unknown, ThrowOnError>;
196
209
  /**
197
210
  * Create job execution
198
- * Creates a new execution for a job by name.
211
+ * 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.
199
212
  */
200
- export declare const createJobExecution: <ThrowOnError extends boolean = false>(options: Options<CreateJobExecutionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").JobExecution, unknown, ThrowOnError>;
213
+ export declare const createJobExecution: <ThrowOnError extends boolean = false>(options: Options<CreateJobExecutionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").CreateJobExecutionResponse, unknown, ThrowOnError>;
201
214
  /**
202
- * Delete job execution
203
- * Stop an execution for a job by name.
215
+ * Cancel job execution
216
+ * 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'.
204
217
  */
205
218
  export declare const deleteJobExecution: <ThrowOnError extends boolean = false>(options: Options<DeleteJobExecutionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").JobExecution, unknown, ThrowOnError>;
206
219
  /**
207
220
  * Get job execution
208
- * Returns an execution for a job by name.
221
+ * Returns detailed information about a specific job execution including status, task statistics (success/failure/running counts), and timing information.
209
222
  */
210
223
  export declare const getJobExecution: <ThrowOnError extends boolean = false>(options: Options<GetJobExecutionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").JobExecution, unknown, ThrowOnError>;
211
224
  /**
@@ -214,64 +227,68 @@ export declare const getJobExecution: <ThrowOnError extends boolean = false>(opt
214
227
  */
215
228
  export declare const listJobRevisions: <ThrowOnError extends boolean = false>(options: Options<ListJobRevisionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").RevisionMetadata[], unknown, ThrowOnError>;
216
229
  /**
217
- * List locations
218
- * Returns a list of all locations available with status.
230
+ * List deployment regions
231
+ * Returns all deployment regions with their current availability status and supported hardware flavors. Use this to discover where resources can be deployed.
219
232
  */
220
233
  export declare const listLocations: <ThrowOnError extends boolean = false>(options?: Options<ListLocationsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").LocationResponse[], unknown, ThrowOnError>;
234
+ /**
235
+ * List MCP Hub servers
236
+ * 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.
237
+ */
221
238
  export declare const listMcpHubDefinitions: <ThrowOnError extends boolean = false>(options?: Options<ListMcpHubDefinitionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").McpDefinition[], unknown, ThrowOnError>;
222
239
  /**
223
- * List models
224
- * Returns a list of all models in the workspace.
240
+ * List model endpoints
241
+ * 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.
225
242
  */
226
- export declare const listModels: <ThrowOnError extends boolean = false>(options?: Options<ListModelsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model[], unknown, ThrowOnError>;
243
+ export declare const listModels: <ThrowOnError extends boolean = false>(options?: Options<ListModelsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model[], import("./types.gen.js")._Error, ThrowOnError>;
227
244
  /**
228
- * Create model
229
- * Creates a model.
245
+ * Create model endpoint
246
+ * 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.
230
247
  */
231
- export declare const createModel: <ThrowOnError extends boolean = false>(options: Options<CreateModelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model, unknown, ThrowOnError>;
248
+ export declare const createModel: <ThrowOnError extends boolean = false>(options: Options<CreateModelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model, import("./types.gen.js")._Error, ThrowOnError>;
232
249
  /**
233
- * Delete model
234
- * Deletes a model by name.
250
+ * Delete model endpoint
251
+ * Permanently deletes a model gateway endpoint. Any agents or applications using this endpoint will need to be updated to use a different model.
235
252
  */
236
- export declare const deleteModel: <ThrowOnError extends boolean = false>(options: Options<DeleteModelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model, unknown, ThrowOnError>;
253
+ export declare const deleteModel: <ThrowOnError extends boolean = false>(options: Options<DeleteModelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model, import("./types.gen.js")._Error, ThrowOnError>;
237
254
  /**
238
- * Get model
239
- * Returns a model by name.
255
+ * Get model endpoint
256
+ * Returns detailed information about a model gateway endpoint including its provider configuration, integration connection, and usage status.
240
257
  */
241
- export declare const getModel: <ThrowOnError extends boolean = false>(options: Options<GetModelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model, unknown, ThrowOnError>;
258
+ export declare const getModel: <ThrowOnError extends boolean = false>(options: Options<GetModelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model, import("./types.gen.js")._Error, ThrowOnError>;
242
259
  /**
243
- * Create or update model
244
- * Update a model by name.
260
+ * Update model endpoint
261
+ * Updates a model gateway endpoint's configuration. Changes to provider settings or integration connection take effect immediately.
245
262
  */
246
- export declare const updateModel: <ThrowOnError extends boolean = false>(options: Options<UpdateModelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model, unknown, ThrowOnError>;
263
+ export declare const updateModel: <ThrowOnError extends boolean = false>(options: Options<UpdateModelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Model, import("./types.gen.js")._Error, ThrowOnError>;
247
264
  /**
248
265
  * List model revisions
249
266
  * Returns revisions for a model by name.
250
267
  */
251
268
  export declare const listModelRevisions: <ThrowOnError extends boolean = false>(options: Options<ListModelRevisionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").RevisionMetadata[], unknown, ThrowOnError>;
252
269
  /**
253
- * List policies
254
- * Returns a list of all policies in the workspace.
270
+ * List governance policies
271
+ * Returns all governance policies in the workspace. Policies control deployment locations, hardware flavors, and token limits for agents, functions, and models.
255
272
  */
256
273
  export declare const listPolicies: <ThrowOnError extends boolean = false>(options?: Options<ListPoliciesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Policy[], unknown, ThrowOnError>;
257
274
  /**
258
- * Create policy
259
- * Creates a policy.
275
+ * Create governance policy
276
+ * 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.
260
277
  */
261
278
  export declare const createPolicy: <ThrowOnError extends boolean = false>(options: Options<CreatePolicyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Policy, unknown, ThrowOnError>;
262
279
  /**
263
- * Delete policy
264
- * Deletes a policy by name.
280
+ * Delete governance policy
281
+ * Permanently deletes a governance policy. Resources using this policy will need to be updated to use a different policy.
265
282
  */
266
283
  export declare const deletePolicy: <ThrowOnError extends boolean = false>(options: Options<DeletePolicyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Policy, unknown, ThrowOnError>;
267
284
  /**
268
- * Get policy
269
- * Returns a policy by name.
285
+ * Get governance policy
286
+ * Returns detailed information about a governance policy including its type (location, flavor, or maxToken), restrictions, and which resource types it applies to.
270
287
  */
271
288
  export declare const getPolicy: <ThrowOnError extends boolean = false>(options: Options<GetPolicyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Policy, unknown, ThrowOnError>;
272
289
  /**
273
- * Update policy
274
- * Updates a policy.
290
+ * Update governance policy
291
+ * Updates a governance policy's restrictions. Changes take effect on the next deployment of resources using this policy.
275
292
  */
276
293
  export declare const updatePolicy: <ThrowOnError extends boolean = false>(options: Options<UpdatePolicyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Policy, unknown, ThrowOnError>;
277
294
  /**
@@ -284,32 +301,36 @@ export declare const listAllPendingInvitations: <ThrowOnError extends boolean =
284
301
  * Returns a list of all public ips used in Blaxel..
285
302
  */
286
303
  export declare const listPublicIps: <ThrowOnError extends boolean = false>(options?: Options<ListPublicIpsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").PublicIps, unknown, ThrowOnError>;
304
+ /**
305
+ * List Sandbox Hub templates
306
+ * Returns all pre-built sandbox templates available in the Blaxel Hub. These include popular development environments with pre-installed tools and frameworks.
307
+ */
287
308
  export declare const listSandboxHubDefinitions: <ThrowOnError extends boolean = false>(options?: Options<ListSandboxHubDefinitionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").SandboxDefinition[], unknown, ThrowOnError>;
288
309
  /**
289
- * List Sandboxes
290
- * Returns a list of all Sandboxes in the workspace.
310
+ * List sandboxes
311
+ * Returns all sandboxes in the workspace. Each sandbox includes its configuration, status, and endpoint URL.
291
312
  */
292
- export declare const listSandboxes: <ThrowOnError extends boolean = false>(options?: Options<ListSandboxesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox[], unknown, ThrowOnError>;
313
+ export declare const listSandboxes: <ThrowOnError extends boolean = false>(options?: Options<ListSandboxesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox[], import("./types.gen.js")._Error, ThrowOnError>;
293
314
  /**
294
- * Create Sandbox
295
- * Creates a Sandbox.
315
+ * Create sandbox
316
+ * 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.
296
317
  */
297
- export declare const createSandbox: <ThrowOnError extends boolean = false>(options: Options<CreateSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox, unknown, ThrowOnError>;
318
+ export declare const createSandbox: <ThrowOnError extends boolean = false>(options: Options<CreateSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox, import("./types.gen.js").SandboxError, ThrowOnError>;
298
319
  /**
299
- * Delete Sandbox
300
- * Deletes a Sandbox by name.
320
+ * Delete sandbox
321
+ * Permanently deletes a sandbox and all its data. If no volumes are attached, this guarantees zero data retention (ZDR). This action cannot be undone.
301
322
  */
302
- export declare const deleteSandbox: <ThrowOnError extends boolean = false>(options: Options<DeleteSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox, unknown, ThrowOnError>;
323
+ export declare const deleteSandbox: <ThrowOnError extends boolean = false>(options: Options<DeleteSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox, import("./types.gen.js")._Error, ThrowOnError>;
303
324
  /**
304
- * Get Sandbox
305
- * Returns a Sandbox by name.
325
+ * Get sandbox
326
+ * Returns detailed information about a sandbox including its configuration, attached volumes, lifecycle policies, and API endpoint URL.
306
327
  */
307
- export declare const getSandbox: <ThrowOnError extends boolean = false>(options: Options<GetSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox, unknown, ThrowOnError>;
328
+ export declare const getSandbox: <ThrowOnError extends boolean = false>(options: Options<GetSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox, import("./types.gen.js")._Error, ThrowOnError>;
308
329
  /**
309
- * Update Sandbox
310
- * Update a Sandbox by name.
330
+ * Update sandbox
331
+ * 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.
311
332
  */
312
- export declare const updateSandbox: <ThrowOnError extends boolean = false>(options: Options<UpdateSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox, unknown, ThrowOnError>;
333
+ export declare const updateSandbox: <ThrowOnError extends boolean = false>(options: Options<UpdateSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Sandbox, import("./types.gen.js")._Error, ThrowOnError>;
313
334
  /**
314
335
  * List Sandboxes
315
336
  * Returns a list of Sandbox Previews in the workspace.
@@ -353,18 +374,8 @@ export declare const deleteSandboxPreviewToken: <ThrowOnError extends boolean =
353
374
  message?: string;
354
375
  }, unknown, ThrowOnError>;
355
376
  /**
356
- * Start Sandbox
357
- * Starts a Sandbox by name.
358
- */
359
- export declare const startSandbox: <ThrowOnError extends boolean = false>(options: Options<StartSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").StartSandbox, unknown, ThrowOnError>;
360
- /**
361
- * Stop Sandbox
362
- * Stops a Sandbox by name.
363
- */
364
- export declare const stopSandbox: <ThrowOnError extends boolean = false>(options: Options<StopSandboxData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").StopSandbox, unknown, ThrowOnError>;
365
- /**
366
- * Get workspace service accounts
367
- * Returns a list of all service accounts in the workspace.
377
+ * List service accounts
378
+ * Returns all service accounts in the workspace. Service accounts are machine identities for external systems to authenticate with Blaxel via OAuth or API keys.
368
379
  */
369
380
  export declare const getWorkspaceServiceAccounts: <ThrowOnError extends boolean = false>(options?: Options<GetWorkspaceServiceAccountsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
370
381
  client_id?: string;
@@ -374,8 +385,8 @@ export declare const getWorkspaceServiceAccounts: <ThrowOnError extends boolean
374
385
  updated_at?: string;
375
386
  }[], unknown, ThrowOnError>;
376
387
  /**
377
- * Create workspace service account
378
- * Creates a service account in the workspace.
388
+ * Create service account
389
+ * 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.
379
390
  */
380
391
  export declare const createWorkspaceServiceAccount: <ThrowOnError extends boolean = false>(options: Options<CreateWorkspaceServiceAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
381
392
  client_id?: string;
@@ -386,8 +397,8 @@ export declare const createWorkspaceServiceAccount: <ThrowOnError extends boolea
386
397
  updated_at?: string;
387
398
  }, unknown, ThrowOnError>;
388
399
  /**
389
- * Delete workspace service account
390
- * Deletes a service account.
400
+ * Delete service account
401
+ * Permanently deletes a service account and invalidates all its credentials. Any systems using this service account will lose access immediately.
391
402
  */
392
403
  export declare const deleteWorkspaceServiceAccount: <ThrowOnError extends boolean = false>(options: Options<DeleteWorkspaceServiceAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
393
404
  client_id?: string;
@@ -397,8 +408,8 @@ export declare const deleteWorkspaceServiceAccount: <ThrowOnError extends boolea
397
408
  updated_at?: string;
398
409
  }, unknown, ThrowOnError>;
399
410
  /**
400
- * Update workspace service account
401
- * Updates a service account.
411
+ * Update service account
412
+ * Updates a service account's name or description. Credentials (client ID/secret) cannot be changed.
402
413
  */
403
414
  export declare const updateWorkspaceServiceAccount: <ThrowOnError extends boolean = false>(options: Options<UpdateWorkspaceServiceAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
404
415
  client_id?: string;
@@ -408,38 +419,38 @@ export declare const updateWorkspaceServiceAccount: <ThrowOnError extends boolea
408
419
  updated_at?: string;
409
420
  }, unknown, ThrowOnError>;
410
421
  /**
411
- * List API keys for service account
412
- * Returns a list of all API keys for a service account.
422
+ * List service account API keys
423
+ * Returns all long-lived API keys created for a service account. API keys provide an alternative to OAuth for simpler authentication scenarios.
413
424
  */
414
425
  export declare const listApiKeysForServiceAccount: <ThrowOnError extends boolean = false>(options: Options<ListApiKeysForServiceAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").ApiKey[], unknown, ThrowOnError>;
415
426
  /**
416
- * Create API key for service account
417
- * Creates an API key for a service account.
427
+ * Create service account API key
428
+ * 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.
418
429
  */
419
430
  export declare const createApiKeyForServiceAccount: <ThrowOnError extends boolean = false>(options: Options<CreateApiKeyForServiceAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").ApiKey, unknown, ThrowOnError>;
420
431
  /**
421
- * Delete API key for service account
422
- * Deletes an API key for a service account.
432
+ * Revoke service account API key
433
+ * Revokes an API key for a service account. The key becomes invalid immediately and any requests using it will fail authentication.
423
434
  */
424
435
  export declare const deleteApiKeyForServiceAccount: <ThrowOnError extends boolean = false>(options: Options<DeleteApiKeyForServiceAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
425
436
  /**
426
- * List templates
427
- * Returns a list of all templates.
437
+ * List deployment templates
438
+ * Returns all deployment templates available for creating agents, functions, and other resources with pre-configured settings and code.
428
439
  */
429
440
  export declare const listTemplates: <ThrowOnError extends boolean = false>(options?: Options<ListTemplatesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Template[], unknown, ThrowOnError>;
430
441
  /**
431
442
  * Get template
432
- * Returns a template by name.
443
+ * Returns detailed information about a deployment template including its configuration, source code reference, and available parameters.
433
444
  */
434
445
  export declare const getTemplate: <ThrowOnError extends boolean = false>(options: Options<GetTemplateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Template, unknown, ThrowOnError>;
435
446
  /**
436
- * List users in workspace
437
- * Returns a list of all users in the workspace.
447
+ * List workspace team members
448
+ * Returns all team members in the workspace including their roles (admin or member) and invitation status.
438
449
  */
439
450
  export declare const listWorkspaceUsers: <ThrowOnError extends boolean = false>(options?: Options<ListWorkspaceUsersData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").WorkspaceUser[], unknown, ThrowOnError>;
440
451
  /**
441
452
  * Invite user to workspace
442
- * Invites a user to the workspace by email.
453
+ * 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.
443
454
  */
444
455
  export declare const inviteWorkspaceUser: <ThrowOnError extends boolean = false>(options: Options<InviteWorkspaceUserData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").PendingInvitation, unknown, ThrowOnError>;
445
456
  /**
@@ -454,12 +465,12 @@ export declare const removeWorkspaceUser: <ThrowOnError extends boolean = false>
454
465
  export declare const updateWorkspaceUserRole: <ThrowOnError extends boolean = false>(options: Options<UpdateWorkspaceUserRoleData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").WorkspaceUser, unknown, ThrowOnError>;
455
466
  /**
456
467
  * List volume templates
457
- * Returns a list of all volume templates.
468
+ * Returns all volume templates in the workspace. Volume templates contain pre-configured filesystem snapshots that can be used to initialize new volumes.
458
469
  */
459
470
  export declare const listVolumeTemplates: <ThrowOnError extends boolean = false>(options?: Options<ListVolumeTemplatesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").VolumeTemplate[], unknown, ThrowOnError>;
460
471
  /**
461
472
  * Create volume template
462
- * Creates a volume template.
473
+ * Creates a new volume template for initializing volumes with pre-configured filesystem contents. Optionally returns a presigned URL for uploading the template archive.
463
474
  */
464
475
  export declare const createVolumeTemplate: <ThrowOnError extends boolean = false>(options: Options<CreateVolumeTemplateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").VolumeTemplate, unknown, ThrowOnError>;
465
476
  /**
@@ -486,50 +497,50 @@ export declare const deleteVolumeTemplateVersion: <ThrowOnError extends boolean
486
497
  template?: import("./types.gen.js").VolumeTemplate;
487
498
  }, unknown, ThrowOnError>;
488
499
  /**
489
- * List volumes
490
- * Returns a list of all volumes in the workspace.
500
+ * List persistent volumes
501
+ * 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.
491
502
  */
492
- export declare const listVolumes: <ThrowOnError extends boolean = false>(options?: Options<ListVolumesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Volume[], unknown, ThrowOnError>;
503
+ export declare const listVolumes: <ThrowOnError extends boolean = false>(options?: Options<ListVolumesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Volume[], import("./types.gen.js")._Error, ThrowOnError>;
493
504
  /**
494
- * Create volume
495
- * Creates a volume.
505
+ * Create persistent volume
506
+ * 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.
496
507
  */
497
- export declare const createVolume: <ThrowOnError extends boolean = false>(options: Options<CreateVolumeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Volume, unknown, ThrowOnError>;
508
+ export declare const createVolume: <ThrowOnError extends boolean = false>(options: Options<CreateVolumeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Volume, import("./types.gen.js")._Error, ThrowOnError>;
498
509
  /**
499
- * Delete volume
500
- * Deletes a volume by name.
510
+ * Delete persistent volume
511
+ * Permanently deletes a volume and all its data. The volume must not be attached to any sandbox. This action cannot be undone.
501
512
  */
502
- export declare const deleteVolume: <ThrowOnError extends boolean = false>(options: Options<DeleteVolumeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Volume, unknown, ThrowOnError>;
513
+ export declare const deleteVolume: <ThrowOnError extends boolean = false>(options: Options<DeleteVolumeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Volume, import("./types.gen.js")._Error, ThrowOnError>;
503
514
  /**
504
- * Get volume
505
- * Returns a volume by name.
515
+ * Get persistent volume
516
+ * Returns detailed information about a volume including its size, region, attachment status, and any events history.
506
517
  */
507
- export declare const getVolume: <ThrowOnError extends boolean = false>(options: Options<GetVolumeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Volume, unknown, ThrowOnError>;
518
+ export declare const getVolume: <ThrowOnError extends boolean = false>(options: Options<GetVolumeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Volume, import("./types.gen.js")._Error, ThrowOnError>;
508
519
  /**
509
- * List workspaces
510
- * Returns a list of all workspaces.
520
+ * List accessible workspaces
521
+ * Returns all workspaces the authenticated user has access to. Each workspace is a separate tenant with its own resources, team members, and billing.
511
522
  */
512
- export declare const listWorkspaces: <ThrowOnError extends boolean = false>(options?: Options<ListWorkspacesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace[], unknown, ThrowOnError>;
523
+ export declare const listWorkspaces: <ThrowOnError extends boolean = false>(options?: Options<ListWorkspacesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace[], import("./types.gen.js")._Error, ThrowOnError>;
513
524
  /**
514
- * Create worspace
515
- * Creates a workspace.
525
+ * Create workspace tenant
526
+ * Creates a new workspace tenant. The authenticated user becomes the workspace admin. Requires a linked billing account.
516
527
  */
517
- export declare const createWorkspace: <ThrowOnError extends boolean = false>(options: Options<CreateWorkspaceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace, unknown, ThrowOnError>;
528
+ export declare const createWorkspace: <ThrowOnError extends boolean = false>(options: Options<CreateWorkspaceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace, import("./types.gen.js")._Error, ThrowOnError>;
518
529
  /**
519
- * Delete workspace
520
- * Deletes a workspace by name.
530
+ * Delete workspace tenant
531
+ * 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.
521
532
  */
522
- export declare const deleteWorkspace: <ThrowOnError extends boolean = false>(options: Options<DeleteWorkspaceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace, unknown, ThrowOnError>;
533
+ export declare const deleteWorkspace: <ThrowOnError extends boolean = false>(options: Options<DeleteWorkspaceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace, import("./types.gen.js")._Error, ThrowOnError>;
523
534
  /**
524
- * Get workspace
525
- * Returns a workspace by name.
535
+ * Get workspace details
536
+ * Returns detailed information about a workspace including its display name, account ID, status, and runtime configuration.
526
537
  */
527
- export declare const getWorkspace: <ThrowOnError extends boolean = false>(options: Options<GetWorkspaceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace, unknown, ThrowOnError>;
538
+ export declare const getWorkspace: <ThrowOnError extends boolean = false>(options: Options<GetWorkspaceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace, import("./types.gen.js")._Error, ThrowOnError>;
528
539
  /**
529
540
  * Update workspace
530
- * Updates a workspace by name.
541
+ * Updates a workspace's settings such as display name and labels. The workspace name cannot be changed after creation.
531
542
  */
532
- export declare const updateWorkspace: <ThrowOnError extends boolean = false>(options: Options<UpdateWorkspaceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace, unknown, ThrowOnError>;
543
+ export declare const updateWorkspace: <ThrowOnError extends boolean = false>(options: Options<UpdateWorkspaceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen.js").Workspace, import("./types.gen.js")._Error, ThrowOnError>;
533
544
  /**
534
545
  * Decline invitation to workspace
535
546
  * Declines an invitation to a workspace.