@deepraxis/sdk 0.0.0-stage → 0.1.0-dev.ea77ce8

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 (64) hide show
  1. package/LICENSE +202 -0
  2. package/METHODS.md +1126 -0
  3. package/README.md +279 -2
  4. package/dist/automation.d.ts +151 -0
  5. package/dist/automation.js +8 -0
  6. package/dist/core/bindings.d.ts +25 -0
  7. package/dist/core/bindings.js +45 -0
  8. package/dist/core/client.d.ts +15 -0
  9. package/dist/core/client.js +15 -0
  10. package/dist/core/credentials.d.ts +14 -0
  11. package/dist/core/credentials.js +33 -0
  12. package/dist/core/errors.d.ts +38 -0
  13. package/dist/core/errors.js +60 -0
  14. package/dist/core/multipart.d.ts +2 -0
  15. package/dist/core/multipart.js +25 -0
  16. package/dist/core/pagination.d.ts +12 -0
  17. package/dist/core/pagination.js +26 -0
  18. package/dist/core/retry.d.ts +13 -0
  19. package/dist/core/retry.js +56 -0
  20. package/dist/core/sse.d.ts +13 -0
  21. package/dist/core/sse.js +67 -0
  22. package/dist/core/transport.d.ts +36 -0
  23. package/dist/core/transport.js +121 -0
  24. package/dist/generated/client/client.gen.d.ts +2 -0
  25. package/dist/generated/client/client.gen.js +216 -0
  26. package/dist/generated/client/index.d.ts +10 -0
  27. package/dist/generated/client/index.js +6 -0
  28. package/dist/generated/client/types.gen.d.ts +120 -0
  29. package/dist/generated/client/types.gen.js +2 -0
  30. package/dist/generated/client/utils.gen.d.ts +37 -0
  31. package/dist/generated/client/utils.gen.js +228 -0
  32. package/dist/generated/client.gen.d.ts +12 -0
  33. package/dist/generated/client.gen.js +3 -0
  34. package/dist/generated/core/auth.gen.d.ts +25 -0
  35. package/dist/generated/core/auth.gen.js +14 -0
  36. package/dist/generated/core/bodySerializer.gen.d.ts +25 -0
  37. package/dist/generated/core/bodySerializer.gen.js +57 -0
  38. package/dist/generated/core/params.gen.d.ts +43 -0
  39. package/dist/generated/core/params.gen.js +109 -0
  40. package/dist/generated/core/pathSerializer.gen.d.ts +33 -0
  41. package/dist/generated/core/pathSerializer.gen.js +106 -0
  42. package/dist/generated/core/queryKeySerializer.gen.d.ts +18 -0
  43. package/dist/generated/core/queryKeySerializer.gen.js +92 -0
  44. package/dist/generated/core/serverSentEvents.gen.d.ts +71 -0
  45. package/dist/generated/core/serverSentEvents.gen.js +132 -0
  46. package/dist/generated/core/types.gen.d.ts +83 -0
  47. package/dist/generated/core/types.gen.js +2 -0
  48. package/dist/generated/core/utils.gen.d.ts +19 -0
  49. package/dist/generated/core/utils.gen.js +87 -0
  50. package/dist/generated/index.d.ts +2 -0
  51. package/dist/generated/index.js +2 -0
  52. package/dist/generated/sdk.gen.d.ts +2172 -0
  53. package/dist/generated/sdk.gen.js +6579 -0
  54. package/dist/generated/types.gen.d.ts +56802 -0
  55. package/dist/generated/types.gen.js +2 -0
  56. package/dist/helpers/application-publish.d.ts +41 -0
  57. package/dist/helpers/application-publish.js +116 -0
  58. package/dist/index.d.ts +9 -0
  59. package/dist/index.js +5 -0
  60. package/dist/operations.generated.d.ts +10965 -0
  61. package/dist/operations.generated.js +13837 -0
  62. package/dist/resources.generated.d.ts +3852 -0
  63. package/dist/resources.generated.js +724 -0
  64. package/package.json +50 -4
@@ -0,0 +1,2172 @@
1
+ import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type ServerSentEventsResult, type TDataShape } from './client/index.js';
2
+ import type { AgentsArchiveData, AgentsArchiveResponses, AgentsCreateData, AgentsCreateResponses, AgentsListData, AgentsListResponses, AgentsRetrieveData, AgentsRetrieveResponses, AgentsUpdateData, AgentsUpdateResponses, AgentsVersionsListData, AgentsVersionsListResponses, ApplicationCreateAssetUploadSessionData, ApplicationCreateAssetUploadSessionErrors, ApplicationCreateAssetUploadSessionResponses, ApplicationCreateDeploymentData, ApplicationCreateDeploymentErrors, ApplicationCreateDeploymentResponses, ApplicationCreateGrantData, ApplicationCreateGrantErrors, ApplicationCreateGrantResponses, ApplicationCreateVersionData, ApplicationCreateVersionErrors, ApplicationCreateVersionResponses, ApplicationCreateWorkerData, ApplicationCreateWorkerErrors, ApplicationCreateWorkerResponses, ApplicationDeleteGrantData, ApplicationDeleteGrantErrors, ApplicationDeleteGrantResponses, ApplicationDeleteSecretData, ApplicationDeleteSecretErrors, ApplicationDeleteSecretResponses, ApplicationDeleteWorkerData, ApplicationDeleteWorkerErrors, ApplicationDeleteWorkerResponses, ApplicationGetDeploymentData, ApplicationGetDeploymentErrors, ApplicationGetDeploymentResponses, ApplicationGetSubdomainData, ApplicationGetSubdomainErrors, ApplicationGetSubdomainResponses, ApplicationGetVersionData, ApplicationGetVersionErrors, ApplicationGetVersionResponses, ApplicationGetWorkerData, ApplicationGetWorkerErrors, ApplicationGetWorkerResponses, ApplicationListComponentsData, ApplicationListComponentsErrors, ApplicationListComponentsResponses, ApplicationListDeploymentsData, ApplicationListDeploymentsErrors, ApplicationListDeploymentsResponses, ApplicationListEventsData, ApplicationListEventsErrors, ApplicationListEventsResponses, ApplicationListGrantsData, ApplicationListGrantsErrors, ApplicationListGrantsResponses, ApplicationListSecretsData, ApplicationListSecretsErrors, ApplicationListSecretsResponses, ApplicationListVersionsData, ApplicationListVersionsErrors, ApplicationListVersionsResponses, ApplicationListWorkersData, ApplicationListWorkersErrors, ApplicationListWorkersResponses, ApplicationPutSecretData, ApplicationPutSecretErrors, ApplicationPutSecretResponses, ApplicationPutSubdomainData, ApplicationPutSubdomainErrors, ApplicationPutSubdomainResponses, ApplicationRestoreWorkerData, ApplicationRestoreWorkerErrors, ApplicationRestoreWorkerResponses, ApplicationUpdateWorkerData, ApplicationUpdateWorkerErrors, ApplicationUpdateWorkerResponses, ApplicationUploadAssetsData, ApplicationUploadAssetsErrors, ApplicationUploadAssetsResponses, AutomationActionsArchiveData, AutomationActionsArchiveErrors, AutomationActionsArchiveResponses, AutomationActionsCreateData, AutomationActionsCreateErrors, AutomationActionsCreateResponses, AutomationActionsDependentsData, AutomationActionsDependentsErrors, AutomationActionsDependentsResponses, AutomationActionsGetData, AutomationActionsGetErrors, AutomationActionsGetResponses, AutomationActionsInvocationsData, AutomationActionsInvocationsErrors, AutomationActionsInvocationsResponses, AutomationActionsListData, AutomationActionsListErrors, AutomationActionsListResponses, AutomationActionsRestoreData, AutomationActionsRestoreErrors, AutomationActionsRestoreResponses, AutomationActionsRevisionData, AutomationActionsRevisionErrors, AutomationActionsRevisionResponses, AutomationActionsRevisionsData, AutomationActionsRevisionsErrors, AutomationActionsRevisionsResponses, AutomationActionsRollbackData, AutomationActionsRollbackErrors, AutomationActionsRollbackResponses, AutomationActionsUpdateData, AutomationActionsUpdateErrors, AutomationActionsUpdateResponses, AutomationHooksReceiveData, AutomationHooksReceiveErrors, AutomationHooksReceiveResponses, AutomationResolveResolveData, AutomationResolveResolveErrors, AutomationResolveResolveResponses, AutomationRunsArtifactsData, AutomationRunsArtifactsErrors, AutomationRunsArtifactsResponses, AutomationRunsCallsData, AutomationRunsCallsErrors, AutomationRunsCallsResponses, AutomationRunsCancelData, AutomationRunsCancelErrors, AutomationRunsCancelResponses, AutomationRunsCompleteWaitData, AutomationRunsCompleteWaitErrors, AutomationRunsCompleteWaitResponses, AutomationRunsCreateData, AutomationRunsCreateErrors, AutomationRunsCreateResponses, AutomationRunsEventsData, AutomationRunsEventsErrors, AutomationRunsEventsResponses, AutomationRunsGetData, AutomationRunsGetErrors, AutomationRunsGetResponses, AutomationRunsListData, AutomationRunsListErrors, AutomationRunsListResponses, AutomationRunsLogsData, AutomationRunsLogsErrors, AutomationRunsLogsResponses, AutomationRunsRerunData, AutomationRunsRerunErrors, AutomationRunsRerunResponses, AutomationRunsResumeData, AutomationRunsResumeErrors, AutomationRunsResumeResponses, AutomationRunsSourceData, AutomationRunsSourceErrors, AutomationRunsSourceResponses, AutomationRunsSuspendData, AutomationRunsSuspendErrors, AutomationRunsSuspendResponses, AutomationRunsTasksData, AutomationRunsTasksErrors, AutomationRunsTasksResponses, AutomationRunsWaitsData, AutomationRunsWaitsErrors, AutomationRunsWaitsResponses, AutomationScriptsArchiveData, AutomationScriptsArchiveErrors, AutomationScriptsArchiveResponses, AutomationScriptsCreateData, AutomationScriptsCreateErrors, AutomationScriptsCreateResponses, AutomationScriptsDeleteDistTagData, AutomationScriptsDeleteDistTagErrors, AutomationScriptsDeleteDistTagResponses, AutomationScriptsDeprecateData, AutomationScriptsDeprecateErrors, AutomationScriptsDeprecateResponses, AutomationScriptsDistTagsData, AutomationScriptsDistTagsErrors, AutomationScriptsDistTagsResponses, AutomationScriptsGetData, AutomationScriptsGetErrors, AutomationScriptsGetResponses, AutomationScriptsListData, AutomationScriptsListErrors, AutomationScriptsListResponses, AutomationScriptsPatchData, AutomationScriptsPatchErrors, AutomationScriptsPatchResponses, AutomationScriptsPublishData, AutomationScriptsPublishErrors, AutomationScriptsPublishResponses, AutomationScriptsRestoreData, AutomationScriptsRestoreErrors, AutomationScriptsRestoreResponses, AutomationScriptsSetDistTagData, AutomationScriptsSetDistTagErrors, AutomationScriptsSetDistTagResponses, AutomationScriptsVersionData, AutomationScriptsVersionErrors, AutomationScriptsVersionResponses, AutomationScriptsVersionsData, AutomationScriptsVersionsErrors, AutomationScriptsVersionsResponses, AutomationTargetsTargetsData, AutomationTargetsTargetsErrors, AutomationTargetsTargetsResponses, AutomationTriggersCreateData, AutomationTriggersCreateErrors, AutomationTriggersCreateResponses, AutomationTriggersDeleteData, AutomationTriggersDeleteErrors, AutomationTriggersDeleteResponses, AutomationTriggersFireData, AutomationTriggersFireErrors, AutomationTriggersFireResponses, AutomationTriggersFiringsData, AutomationTriggersFiringsErrors, AutomationTriggersFiringsResponses, AutomationTriggersGetData, AutomationTriggersGetErrors, AutomationTriggersGetResponses, AutomationTriggersListData, AutomationTriggersListErrors, AutomationTriggersListResponses, AutomationTriggersPatchData, AutomationTriggersPatchErrors, AutomationTriggersPatchResponses, AutomationTriggersPauseData, AutomationTriggersPauseErrors, AutomationTriggersPauseResponses, AutomationTriggersPreviewData, AutomationTriggersPreviewErrors, AutomationTriggersPreviewResponses, AutomationTriggersResumeData, AutomationTriggersResumeErrors, AutomationTriggersResumeResponses, AutomationTriggersRotateWebhookData, AutomationTriggersRotateWebhookErrors, AutomationTriggersRotateWebhookResponses, AutomationValidateValidateData, AutomationValidateValidateErrors, AutomationValidateValidateResponses, AutomationWorkflowsArchiveData, AutomationWorkflowsArchiveErrors, AutomationWorkflowsArchiveResponses, AutomationWorkflowsCreateData, AutomationWorkflowsCreateErrors, AutomationWorkflowsCreateResponses, AutomationWorkflowsDeleteDistTagData, AutomationWorkflowsDeleteDistTagErrors, AutomationWorkflowsDeleteDistTagResponses, AutomationWorkflowsDeprecateData, AutomationWorkflowsDeprecateErrors, AutomationWorkflowsDeprecateResponses, AutomationWorkflowsDistTagsData, AutomationWorkflowsDistTagsErrors, AutomationWorkflowsDistTagsResponses, AutomationWorkflowsGetData, AutomationWorkflowsGetErrors, AutomationWorkflowsGetResponses, AutomationWorkflowsListData, AutomationWorkflowsListErrors, AutomationWorkflowsListResponses, AutomationWorkflowsPatchData, AutomationWorkflowsPatchErrors, AutomationWorkflowsPatchResponses, AutomationWorkflowsPublishData, AutomationWorkflowsPublishErrors, AutomationWorkflowsPublishResponses, AutomationWorkflowsRestoreData, AutomationWorkflowsRestoreErrors, AutomationWorkflowsRestoreResponses, AutomationWorkflowsSetDistTagData, AutomationWorkflowsSetDistTagErrors, AutomationWorkflowsSetDistTagResponses, AutomationWorkflowsVersionData, AutomationWorkflowsVersionErrors, AutomationWorkflowsVersionResponses, AutomationWorkflowsVersionsData, AutomationWorkflowsVersionsErrors, AutomationWorkflowsVersionsResponses, BrowserCloseSessionData, BrowserCloseSessionErrors, BrowserCloseSessionResponses, BrowserCompleteHandoffData, BrowserCompleteHandoffErrors, BrowserCompleteHandoffResponses, BrowserConnectData, BrowserConnectErrors, BrowserCreateContextData, BrowserCreateContextErrors, BrowserCreateContextResponses, BrowserCreateSessionData, BrowserCreateSessionErrors, BrowserCreateSessionResponses, BrowserDeleteContextData, BrowserDeleteContextErrors, BrowserDeleteContextResponses, BrowserGetContextData, BrowserGetContextErrors, BrowserGetContextResponses, BrowserGetDebugData, BrowserGetDebugErrors, BrowserGetDebugResponses, BrowserGetSessionData, BrowserGetSessionErrors, BrowserGetSessionResponses, BrowserListContextsData, BrowserListContextsErrors, BrowserListContextsResponses, BrowserListEventsData, BrowserListEventsErrors, BrowserListEventsResponses, BrowserListSessionsData, BrowserListSessionsErrors, BrowserListSessionsResponses, BrowserLiveViewData, BrowserLiveViewErrors, BrowserRequestHandoffData, BrowserRequestHandoffErrors, BrowserRequestHandoffResponses, BrowserSeleniumUnsupportedData, BrowserSeleniumUnsupportedErrors, BrowserStreamSessionData, BrowserStreamSessionResponse, BrowserStreamSessionResponses, BrowserUpdateContextData, BrowserUpdateContextErrors, BrowserUpdateContextResponses, BrowserViewerHeartbeatData, BrowserViewerHeartbeatErrors, BrowserViewerHeartbeatResponses, CancelResponseData, CancelResponseErrors, CancelResponseResponses, CompactResponseData, CompactResponseErrors, CompactResponseResponses, CompactSessionData, CompactSessionErrors, CompactSessionResponses, ComputersArchiveData, ComputersArchiveErrors, ComputersArchiveResponses, ComputersAttachmentsCreateData, ComputersAttachmentsCreateErrors, ComputersAttachmentsCreateResponses, ComputersCreateData, ComputersCreateErrors, ComputersCreateResponses, ComputersDeleteData, ComputersDeleteErrors, ComputersDeleteResponses, ComputersFilesContentData, ComputersFilesContentErrors, ComputersFilesContentResponses, ComputersFilesListData, ComputersFilesListErrors, ComputersFilesListResponses, ComputersListData, ComputersListErrors, ComputersListResponses, ComputersRetrieveData, ComputersRetrieveErrors, ComputersRetrieveResponses, ComputersUpdateData, ComputersUpdateErrors, ComputersUpdateResponses, ConnectComputerData, ConnectComputerErrors, ConnectComputerResponses, CountResponseInputTokensData, CountResponseInputTokensErrors, CountResponseInputTokensResponses, CountTokensData, CountTokensErrors, CountTokensResponses, CreateAudioSpeechData, CreateAudioSpeechErrors, CreateAudioSpeechResponses, CreateAudioTranscriptionData, CreateAudioTranscriptionErrors, CreateAudioTranscriptionResponses, CreateChatCompletionData, CreateChatCompletionErrors, CreateChatCompletionResponses, CreateConversationData, CreateConversationItemsData, CreateConversationItemsErrors, CreateConversationItemsResponses, CreateConversationResponses, CreateEmbeddingData, CreateEmbeddingErrors, CreateEmbeddingResponses, CreateEmbedTokenData, CreateEmbedTokenErrors, CreateEmbedTokenResponses, CreateImageData, CreateImageErrors, CreateImageResponses, CreateMessageData, CreateMessageErrors, CreateMessageResponses, CreateOcrData, CreateOcrErrors, CreateOcrResponses, CreateOrganizationFeedbackData, CreateOrganizationFeedbackErrors, CreateOrganizationFeedbackResponses, CreateResponseData, CreateResponseErrors, CreateResponseResponses, CreateVideoData, CreateVideoErrors, CreateVideoResponses, DatabaseAddFieldData, DatabaseAddFieldErrors, DatabaseAddFieldResponses, DatabaseCreateDatabaseData, DatabaseCreateDatabaseErrors, DatabaseCreateDatabaseResponses, DatabaseCreateTableData, DatabaseCreateTableErrors, DatabaseCreateTableResponses, DatabaseDeleteData, DatabaseDeleteDatabaseData, DatabaseDeleteDatabaseErrors, DatabaseDeleteDatabaseResponses, DatabaseDeleteErrors, DatabaseDeleteFieldData, DatabaseDeleteFieldErrors, DatabaseDeleteFieldResponses, DatabaseDeleteResponses, DatabaseDeleteTableData, DatabaseDeleteTableErrors, DatabaseDeleteTableResponses, DatabaseGetDatabaseData, DatabaseGetDatabaseErrors, DatabaseGetDatabaseResponses, DatabaseGetTableData, DatabaseGetTableErrors, DatabaseGetTableResponses, DatabaseHeadData, DatabaseHeadErrors, DatabaseHeadResponses, DatabaseInsertData, DatabaseInsertErrors, DatabaseInsertResponses, DatabaseListDatabasesData, DatabaseListDatabasesErrors, DatabaseListDatabasesResponses, DatabaseListEventsData, DatabaseListEventsErrors, DatabaseListEventsResponses, DatabaseListTablesData, DatabaseListTablesErrors, DatabaseListTablesResponses, DatabasePurgeDatabaseData, DatabasePurgeDatabaseErrors, DatabasePurgeDatabaseResponses, DatabaseRestoreDatabaseData, DatabaseRestoreDatabaseErrors, DatabaseRestoreDatabaseResponses, DatabaseSelectData, DatabaseSelectErrors, DatabaseSelectResponses, DatabaseUpdateData, DatabaseUpdateDatabaseData, DatabaseUpdateDatabaseErrors, DatabaseUpdateDatabaseResponses, DatabaseUpdateErrors, DatabaseUpdateFieldData, DatabaseUpdateFieldErrors, DatabaseUpdateFieldResponses, DatabaseUpdateResponses, DatabaseUpdateTableData, DatabaseUpdateTableErrors, DatabaseUpdateTableResponses, DeleteConversationData, DeleteConversationErrors, DeleteConversationItemData, DeleteConversationItemErrors, DeleteConversationItemResponses, DeleteConversationResponses, DeleteResponseData, DeleteResponseResponses, DeleteRunFeedbackData, DeleteRunFeedbackErrors, DeleteRunFeedbackResponses, DeleteSandboxV1SandboxesBySandboxIdData, DeleteSandboxV1SandboxesBySandboxIdErrors, DeleteSandboxV1SandboxesBySandboxIdResponses, DeleteSandboxV1SnapshotsBySnapshotIdData, DeleteSandboxV1SnapshotsBySnapshotIdErrors, DeleteSandboxV1SnapshotsBySnapshotIdResponses, DeleteSandboxV1VolumesByVolumeIdData, DeleteSandboxV1VolumesByVolumeIdErrors, DeleteSandboxV1VolumesByVolumeIdResponses, DeleteVideoData, DeleteVideoErrors, DeleteVideoResponses, DeploymentRunsListData, DeploymentRunsListResponses, DeploymentRunsRetrieveData, DeploymentRunsRetrieveResponses, DeploymentsArchiveData, DeploymentsArchiveResponses, DeploymentsCreateData, DeploymentsCreateResponses, DeploymentsListData, DeploymentsListResponses, DeploymentsPauseData, DeploymentsPauseResponses, DeploymentsRetrieveData, DeploymentsRetrieveResponses, DeploymentsRunData, DeploymentsRunResponses, DeploymentsUnpauseData, DeploymentsUnpauseResponses, DeploymentsUpdateData, DeploymentsUpdateResponses, DownloadVideoContentData, DownloadVideoContentErrors, DownloadVideoContentResponses, EditImageData, EditImageErrors, EditImageResponses, EnvironmentsArchiveData, EnvironmentsArchiveResponses, EnvironmentsCreateData, EnvironmentsCreateResponses, EnvironmentsListData, EnvironmentsListResponses, EnvironmentsRetrieveData, EnvironmentsRetrieveResponses, EnvironmentsUpdateData, EnvironmentsUpdateResponses, ExportOrganizationChargesData, ExportOrganizationChargesErrors, ExportOrganizationChargesResponses, ExtendSandboxData, ExtendSandboxErrors, ExtendSandboxResponses, FileCreateFileData, FileCreateFileErrors, FileCreateFileResponses, FileDeleteFileData, FileDeleteFileErrors, FileDeleteFileResponses, FileListFilesData, FileListFilesErrors, FileListFilesResponses, FileRetrieveFileContentData, FileRetrieveFileContentErrors, FileRetrieveFileContentResponses, FileRetrieveFileData, FileRetrieveFileErrors, FileRetrieveFileResponses, ForkSessionData, ForkSessionErrors, ForkSessionResponses, GetGenerationData, GetGenerationErrors, GetGenerationResponses, GetObservedProcessOutputData, GetObservedProcessOutputErrors, GetObservedProcessOutputResponses, GetOrganizationEventData, GetOrganizationEventErrors, GetOrganizationEventResponses, GetSandboxV1SandboxesBySandboxIdData, GetSandboxV1SandboxesBySandboxIdErrors, GetSandboxV1SandboxesBySandboxIdLogsData, GetSandboxV1SandboxesBySandboxIdLogsErrors, GetSandboxV1SandboxesBySandboxIdLogsResponses, GetSandboxV1SandboxesBySandboxIdMetricsData, GetSandboxV1SandboxesBySandboxIdMetricsErrors, GetSandboxV1SandboxesBySandboxIdMetricsResponses, GetSandboxV1SandboxesBySandboxIdResponses, GetSandboxV1SandboxesData, GetSandboxV1SandboxesErrors, GetSandboxV1SandboxesResponses, GetSandboxV1SnapshotsData, GetSandboxV1SnapshotsErrors, GetSandboxV1SnapshotsResponses, GetSandboxV1TemplatesData, GetSandboxV1TemplatesErrors, GetSandboxV1TemplatesResponses, GetSandboxV1VolumesByVolumeIdData, GetSandboxV1VolumesByVolumeIdErrors, GetSandboxV1VolumesByVolumeIdResponses, GetSandboxV1VolumesData, GetSandboxV1VolumesErrors, GetSandboxV1VolumesResponses, GetSessionBackgroundTaskOutputData, GetSessionBackgroundTaskOutputErrors, GetSessionBackgroundTaskOutputResponses, GetSessionCompactionData, GetSessionCompactionErrors, GetSessionCompactionResponses, GetSessionContextData, GetSessionContextErrors, GetSessionContextResponses, HealthCheckData, HealthCheckResponses, KnowledgeAttachFileData, KnowledgeAttachFileErrors, KnowledgeAttachFileResponses, KnowledgeCancelFileBatchData, KnowledgeCancelFileBatchErrors, KnowledgeCancelFileBatchResponses, KnowledgeCreateFileBatchData, KnowledgeCreateFileBatchErrors, KnowledgeCreateFileBatchResponses, KnowledgeCreateVectorStoreData, KnowledgeCreateVectorStoreErrors, KnowledgeCreateVectorStoreResponses, KnowledgeDeleteVectorStoreData, KnowledgeDeleteVectorStoreErrors, KnowledgeDeleteVectorStoreResponses, KnowledgeListBatchFilesData, KnowledgeListBatchFilesErrors, KnowledgeListBatchFilesResponses, KnowledgeListEventsData, KnowledgeListEventsErrors, KnowledgeListEventsResponses, KnowledgeListFilesData, KnowledgeListFilesErrors, KnowledgeListFilesResponses, KnowledgeListSegmentsData, KnowledgeListSegmentsErrors, KnowledgeListSegmentsResponses, KnowledgeListVectorStoresData, KnowledgeListVectorStoresErrors, KnowledgeListVectorStoresResponses, KnowledgePurgeVectorStoreData, KnowledgePurgeVectorStoreErrors, KnowledgePurgeVectorStoreResponses, KnowledgeRemoveFileData, KnowledgeRemoveFileErrors, KnowledgeRemoveFileResponses, KnowledgeRestoreVectorStoreData, KnowledgeRestoreVectorStoreErrors, KnowledgeRestoreVectorStoreResponses, KnowledgeRetrieveFileBatchData, KnowledgeRetrieveFileBatchErrors, KnowledgeRetrieveFileBatchResponses, KnowledgeRetrieveFileContentData, KnowledgeRetrieveFileContentErrors, KnowledgeRetrieveFileContentResponses, KnowledgeRetrieveFileData, KnowledgeRetrieveFileErrors, KnowledgeRetrieveFileResponses, KnowledgeRetrieveSegmentData, KnowledgeRetrieveSegmentErrors, KnowledgeRetrieveSegmentResponses, KnowledgeRetrieveVectorStoreData, KnowledgeRetrieveVectorStoreErrors, KnowledgeRetrieveVectorStoreResponses, KnowledgeRetryFileData, KnowledgeRetryFileErrors, KnowledgeRetryFileResponses, KnowledgeSearchVectorStoreData, KnowledgeSearchVectorStoreErrors, KnowledgeSearchVectorStoreResponses, KnowledgeUpdateFileData, KnowledgeUpdateFileErrors, KnowledgeUpdateFileResponses, KnowledgeUpdateVectorStoreData, KnowledgeUpdateVectorStoreErrors, KnowledgeUpdateVectorStoreResponses, ListConversationItemsData, ListConversationItemsErrors, ListConversationItemsResponses, ListEmbedTokensData, ListEmbedTokensErrors, ListEmbedTokensResponses, ListModelsData, ListModelsErrors, ListModelsResponses, ListObservedProcessesData, ListObservedProcessesErrors, ListObservedProcessesResponses, ListOrganizationCostsData, ListOrganizationCostsErrors, ListOrganizationCostsResponses, ListOrganizationEventsData, ListOrganizationEventsErrors, ListOrganizationEventsResponses, ListOrganizationUsageData, ListOrganizationUsageErrors, ListOrganizationUsageResponses, ListResponseInputItemsData, ListResponseInputItemsResponses, ListSandboxFilesData, ListSandboxFilesErrors, ListSandboxFilesResponses, ListSessionBackgroundTasksData, ListSessionBackgroundTasksErrors, ListSessionBackgroundTasksResponses, ListSessionCompactionsData, ListSessionCompactionsErrors, ListSessionCompactionsResponses, ListToolsetsData, ListToolsetsErrors, ListToolsetsResponses, ListVideosData, ListVideosErrors, ListVideosResponses, MakeSandboxDirectoryData, MakeSandboxDirectoryErrors, MakeSandboxDirectoryResponses, MediaBatchAssetsData, MediaBatchAssetsErrors, MediaBatchAssetsResponses, MediaCreateBatchData, MediaCreateBatchErrors, MediaCreateBatchResponses, MediaCreateLibraryData, MediaCreateLibraryErrors, MediaCreateLibraryResponses, MediaDeleteAssetData, MediaDeleteAssetErrors, MediaDeleteAssetResponses, MediaDeleteLibraryData, MediaDeleteLibraryErrors, MediaDeleteLibraryResponses, MediaExpressionSearchData, MediaExpressionSearchErrors, MediaExpressionSearchResponses, MediaGetAssetData, MediaGetAssetErrors, MediaGetAssetResponses, MediaGetBatchData, MediaGetBatchErrors, MediaGetBatchResponses, MediaGetJobData, MediaGetJobErrors, MediaGetJobResponses, MediaGetLibraryData, MediaGetLibraryErrors, MediaGetLibraryResponses, MediaImportAssetData, MediaImportAssetErrors, MediaImportAssetResponses, MediaListAssetsData, MediaListAssetsErrors, MediaListAssetsResponses, MediaListEventsData, MediaListEventsErrors, MediaListEventsResponses, MediaListFoldersData, MediaListFoldersErrors, MediaListFoldersResponses, MediaListLibrariesData, MediaListLibrariesErrors, MediaListLibrariesResponses, MediaListUnderstandingsData, MediaListUnderstandingsErrors, MediaListUnderstandingsResponses, MediaPurgeLibraryData, MediaPurgeLibraryErrors, MediaPurgeLibraryResponses, MediaReprocessAssetData, MediaReprocessAssetErrors, MediaReprocessAssetResponses, MediaRestoreLibraryData, MediaRestoreLibraryErrors, MediaRestoreLibraryResponses, MediaSearchData, MediaSearchErrors, MediaSearchResponses, MediaSemanticSearchData, MediaSemanticSearchErrors, MediaSemanticSearchResponses, MediaUpdateAssetData, MediaUpdateAssetErrors, MediaUpdateAssetResponses, MediaUpdateLibraryData, MediaUpdateLibraryErrors, MediaUpdateLibraryResponses, MediaUploadAssetData, MediaUploadAssetErrors, MediaUploadAssetResponses, MediaVisualSearchData, MediaVisualSearchErrors, MediaVisualSearchResponses, MetaMethodsRetrieveData, MetaMethodsRetrieveErrors, MetaMethodsRetrieveResponses, MetaMethodsSearchData, MetaMethodsSearchErrors, MetaMethodsSearchResponses, PostSandboxV1SandboxesBySandboxIdConnectData, PostSandboxV1SandboxesBySandboxIdConnectErrors, PostSandboxV1SandboxesBySandboxIdConnectResponses, PostSandboxV1SandboxesBySandboxIdForkData, PostSandboxV1SandboxesBySandboxIdForkErrors, PostSandboxV1SandboxesBySandboxIdForkResponses, PostSandboxV1SandboxesBySandboxIdPauseData, PostSandboxV1SandboxesBySandboxIdPauseErrors, PostSandboxV1SandboxesBySandboxIdPauseResponses, PostSandboxV1SandboxesBySandboxIdSnapshotsData, PostSandboxV1SandboxesBySandboxIdSnapshotsErrors, PostSandboxV1SandboxesBySandboxIdSnapshotsResponses, PostSandboxV1SandboxesBySandboxIdTimeoutData, PostSandboxV1SandboxesBySandboxIdTimeoutErrors, PostSandboxV1SandboxesBySandboxIdTimeoutResponses, PostSandboxV1SandboxesData, PostSandboxV1SandboxesErrors, PostSandboxV1SandboxesResponses, PostSandboxV1VolumesData, PostSandboxV1VolumesErrors, PostSandboxV1VolumesResponses, PutSandboxV1SandboxesBySandboxIdNetworkData, PutSandboxV1SandboxesBySandboxIdNetworkErrors, PutSandboxV1SandboxesBySandboxIdNetworkResponses, ReadSandboxFileData, ReadSandboxFileErrors, ReadSandboxFileResponses, RemixVideoData, RemixVideoErrors, RemoveSandboxFileData, RemoveSandboxFileErrors, RemoveSandboxFileResponses, RenameSandboxData, RenameSandboxErrors, RenameSandboxResponses, RerankData, RerankErrors, RerankResponses, RetrieveConversationData, RetrieveConversationErrors, RetrieveConversationItemData, RetrieveConversationItemErrors, RetrieveConversationItemResponses, RetrieveConversationResponses, RetrieveModelData, RetrieveModelErrors, RetrieveModelResponses, RetrieveResponseData, RetrieveResponseResponses, RetrieveVideoData, RetrieveVideoErrors, RetrieveVideoResponses, RevokeEmbedTokenData, RevokeEmbedTokenErrors, RevokeEmbedTokenResponses, RunSandboxCommandData, RunSandboxCommandErrors, RunSandboxCommandResponses, SearchCrawlData, SearchCrawlErrors, SearchCrawlResponses, SearchExtractData, SearchExtractErrors, SearchExtractResponses, SearchMapData, SearchMapErrors, SearchMapResponses, SearchSearchData, SearchSearchErrors, SearchSearchResponses, SessionsArchiveData, SessionsArchiveResponses, SessionsCreateData, SessionsCreateResponses, SessionsEventsListData, SessionsEventsListResponses, SessionsEventsSendData, SessionsEventsSendResponses, SessionsEventsStreamData, SessionsEventsStreamResponse, SessionsEventsStreamResponses, SessionsListData, SessionsListResponses, SessionsResourcesAddData, SessionsResourcesAddResponses, SessionsResourcesDeleteData, SessionsResourcesDeleteResponses, SessionsResourcesListData, SessionsResourcesListResponses, SessionsResourcesRetrieveData, SessionsResourcesRetrieveResponses, SessionsRetrieveData, SessionsRetrieveResponses, SessionsThreadsArchiveData, SessionsThreadsArchiveResponses, SessionsThreadsEventsListData, SessionsThreadsEventsListResponses, SessionsThreadsEventsStreamData, SessionsThreadsEventsStreamResponse, SessionsThreadsEventsStreamResponses, SessionsThreadsListData, SessionsThreadsListResponses, SessionsThreadsRetrieveData, SessionsThreadsRetrieveResponses, SessionsUpdateData, SessionsUpdateResponses, SetRunFeedbackData, SetRunFeedbackErrors, SetRunFeedbackResponses, StopSessionBackgroundTaskData, StopSessionBackgroundTaskErrors, StopSessionBackgroundTaskResponses, UpdateConversationData, UpdateConversationErrors, UpdateConversationResponses, UpgradeSandboxData, UpgradeSandboxErrors, UpgradeSandboxResponses, VaultArchiveSecretData, VaultArchiveSecretErrors, VaultArchiveSecretResponses, VaultArchiveVaultData, VaultArchiveVaultErrors, VaultArchiveVaultResponses, VaultAuthorizationCallbackData, VaultAuthorizationCallbackResponses, VaultCheckVaultsData, VaultCheckVaultsErrors, VaultCheckVaultsResponses, VaultConnectContinueData, VaultConnectDenyData, VaultConnectDenyResponses, VaultConnectPageData, VaultConnectPageErrors, VaultConnectPageResponses, VaultCreateAuthorizationData, VaultCreateAuthorizationErrors, VaultCreateAuthorizationResponses, VaultCreateSecretData, VaultCreateSecretErrors, VaultCreateSecretResponses, VaultCreateVaultData, VaultCreateVaultErrors, VaultCreateVaultResponses, VaultDeleteSecretData, VaultDeleteSecretErrors, VaultDeleteSecretResponses, VaultDeleteVaultData, VaultDeleteVaultErrors, VaultDeleteVaultResponses, VaultGetAuthorizationData, VaultGetAuthorizationErrors, VaultGetAuthorizationResponses, VaultGetReturnUrlsData, VaultGetReturnUrlsErrors, VaultGetReturnUrlsResponses, VaultGetSecretData, VaultGetSecretErrors, VaultGetSecretResponses, VaultGetVaultData, VaultGetVaultErrors, VaultGetVaultResponses, VaultImportSecretsData, VaultImportSecretsErrors, VaultImportSecretsResponses, VaultListEventsData, VaultListEventsErrors, VaultListEventsResponses, VaultListSecretsData, VaultListSecretsErrors, VaultListSecretsResponses, VaultListTemplatesData, VaultListTemplatesErrors, VaultListTemplatesResponses, VaultListVaultsData, VaultListVaultsErrors, VaultListVaultsResponses, VaultOAuthClientMetadataData, VaultOAuthClientMetadataResponses, VaultRefreshSecretData, VaultRefreshSecretErrors, VaultRefreshSecretResponses, VaultSetReturnUrlsData, VaultSetReturnUrlsErrors, VaultSetReturnUrlsResponses, VaultUpdateSecretData, VaultUpdateSecretErrors, VaultUpdateSecretResponses, VaultUpdateVaultData, VaultUpdateVaultErrors, VaultUpdateVaultResponses, VaultValidateSecretData, VaultValidateSecretErrors, VaultValidateSecretResponses, WriteSandboxFileData, WriteSandboxFileErrors, WriteSandboxFileResponses } from './types.gen.js';
3
+ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
4
+ /**
5
+ * You can provide a client instance returned by `createClient()` instead of
6
+ * individual options. This might be also useful if you want to implement a
7
+ * custom client.
8
+ */
9
+ client?: Client;
10
+ /**
11
+ * You can pass arbitrary values through the `meta` object. This can be
12
+ * used to access values that aren't defined as part of the SDK function.
13
+ */
14
+ meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
15
+ };
16
+ /**
17
+ * Delete Run Feedback
18
+ *
19
+ * Remove the rating and comment for a run.
20
+ *
21
+ * Own-face extension. Use the session id from session creation or listing and the run_id from its events. Requires a readable session and a run belonging to it. Idempotent; returns 204 even when no feedback exists. End users can delete feedback only for their own sessions. Does not delete the run or messages, enter model context, or start another run.
22
+ */
23
+ export declare const deleteRunFeedback: <ThrowOnError extends boolean = false>(options: Options<DeleteRunFeedbackData, ThrowOnError>) => RequestResult<DeleteRunFeedbackResponses, DeleteRunFeedbackErrors, ThrowOnError>;
24
+ /**
25
+ * Set Run Feedback
26
+ *
27
+ * Submit thumbs up or thumbs down for a run, with an optional comment.
28
+ *
29
+ * Own-face extension. Use a readable session and a run_id from its events. Each submission replaces the previous rating and comment; omitted or null comment clears it, while created_at is preserved. Comments allow at most 2000 Unicode characters. End users can submit only for their own sessions. Feedback never enters model context or starts a run. For example, submit {"rating":"positive","comment":"Helpful"}. POST follows Managed Agents resource update conventions; the resource remains unique per session and run.
30
+ */
31
+ export declare const setRunFeedback: <ThrowOnError extends boolean = false>(options: Options<SetRunFeedbackData, ThrowOnError>) => RequestResult<SetRunFeedbackResponses, SetRunFeedbackErrors, ThrowOnError>;
32
+ /**
33
+ * List Embed Tokens
34
+ *
35
+ * List embed token issuance records in your organization.
36
+ *
37
+ * Includes expired and revoked grants; returns neither token nor token_id. Sorts by created_at, then grant id, both descending. agent_id accepts agent_ or agt_; external_user_id matches exactly. limit is 1–100 (default 20). Reuse next_page as page with the same filters and organization; a mismatch returns 400. End-user credentials return 404.
38
+ */
39
+ export declare const listEmbedTokens: <ThrowOnError extends boolean = false>(options?: Options<ListEmbedTokensData, ThrowOnError>) => RequestResult<ListEmbedTokensResponses, ListEmbedTokensErrors, ThrowOnError>;
40
+ /**
41
+ * Create Embed Token
42
+ *
43
+ * Issue a short-lived credential on your backend for an end user of a service agent.
44
+ *
45
+ * Requires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. The hosted field is not supported.
46
+ */
47
+ export declare const createEmbedToken: <ThrowOnError extends boolean = false>(options: Options<CreateEmbedTokenData, ThrowOnError>) => RequestResult<CreateEmbedTokenResponses, CreateEmbedTokenErrors, ThrowOnError>;
48
+ /**
49
+ * Revoke Embed Token
50
+ *
51
+ * Revoke an embed token and close its open event streams.
52
+ *
53
+ * Use an id from issuance or listing. Revokes the credential before setting revoked_at; upstream failure leaves it unset. Streams receive session.error (EMBED_TOKEN_REVOKED), then close immediately; other credentials are unaffected. Idempotent; repeats return the original revoked record without another revocation or audit. Missing or foreign grants and end-user credentials return 404.
54
+ */
55
+ export declare const revokeEmbedToken: <ThrowOnError extends boolean = false>(options: Options<RevokeEmbedTokenData, ThrowOnError>) => RequestResult<RevokeEmbedTokenResponses, RevokeEmbedTokenErrors, ThrowOnError>;
56
+ /**
57
+ * ComputersList
58
+ *
59
+ * Tenant-owned durable computer resource.
60
+ *
61
+ * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
62
+ */
63
+ export declare const computersList: <ThrowOnError extends boolean = false>(options?: Options<ComputersListData, ThrowOnError>) => RequestResult<ComputersListResponses, ComputersListErrors, ThrowOnError>;
64
+ /**
65
+ * ComputersCreate
66
+ *
67
+ * Tenant-owned durable computer resource.
68
+ *
69
+ * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
70
+ */
71
+ export declare const computersCreate: <ThrowOnError extends boolean = false>(options: Options<ComputersCreateData, ThrowOnError>) => RequestResult<ComputersCreateResponses, ComputersCreateErrors, ThrowOnError>;
72
+ /**
73
+ * Delete Archived Computer
74
+ *
75
+ * Permanently delete an archived explicit computer and its files and code runs.
76
+ *
77
+ * Own-face superset: Managed Agents has no persistent Computer deletion lifecycle. Only archived computers can be deleted. Active computers return 400 COMPUTER_ACTIVE (archive first). Destroy storage before removing registration. Success returns id and type=computer_deleted; missing or foreign computers return 404.
78
+ */
79
+ export declare const computersDelete: <ThrowOnError extends boolean = false>(options: Options<ComputersDeleteData, ThrowOnError>) => RequestResult<ComputersDeleteResponses, ComputersDeleteErrors, ThrowOnError>;
80
+ /**
81
+ * ComputersRetrieve
82
+ *
83
+ * Tenant-owned durable computer resource.
84
+ *
85
+ * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
86
+ */
87
+ export declare const computersRetrieve: <ThrowOnError extends boolean = false>(options: Options<ComputersRetrieveData, ThrowOnError>) => RequestResult<ComputersRetrieveResponses, ComputersRetrieveErrors, ThrowOnError>;
88
+ /**
89
+ * ComputersUpdate
90
+ *
91
+ * Tenant-owned durable computer resource.
92
+ *
93
+ * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
94
+ */
95
+ export declare const computersUpdate: <ThrowOnError extends boolean = false>(options: Options<ComputersUpdateData, ThrowOnError>) => RequestResult<ComputersUpdateResponses, ComputersUpdateErrors, ThrowOnError>;
96
+ /**
97
+ * ComputersArchive
98
+ *
99
+ * Tenant-owned durable computer resource.
100
+ *
101
+ * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
102
+ */
103
+ export declare const computersArchive: <ThrowOnError extends boolean = false>(options: Options<ComputersArchiveData, ThrowOnError>) => RequestResult<ComputersArchiveResponses, ComputersArchiveErrors, ThrowOnError>;
104
+ /**
105
+ * Upload Computer Attachment
106
+ *
107
+ * Upload raw bytes into /attachments and return the same FileInfo as the file list.
108
+ *
109
+ * Own-face superset: Managed Agents has no persistent Computer attachment directory. User uploads overwrite the same name; agents retain read-only access. Run-token uploads return 403 READ_ONLY. name is one filename of at most 255 UTF-8 bytes; MIME is inferred from the extension; custom Content-Type is not persisted and digest may be absent. Limit 16 MiB (413); invalid names return 400. Archived computers accept uploads; foreign computers return 404.
110
+ */
111
+ export declare const computersAttachmentsCreate: <ThrowOnError extends boolean = false>(options: Options<ComputersAttachmentsCreateData, ThrowOnError>) => RequestResult<ComputersAttachmentsCreateResponses, ComputersAttachmentsCreateErrors, ThrowOnError>;
112
+ /**
113
+ * ComputersFilesList
114
+ *
115
+ * Tenant-owned durable computer resource.
116
+ *
117
+ * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
118
+ */
119
+ export declare const computersFilesList: <ThrowOnError extends boolean = false>(options: Options<ComputersFilesListData, ThrowOnError>) => RequestResult<ComputersFilesListResponses, ComputersFilesListErrors, ThrowOnError>;
120
+ /**
121
+ * ComputersFilesContent
122
+ *
123
+ * Tenant-owned durable computer resource.
124
+ *
125
+ * Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
126
+ */
127
+ export declare const computersFilesContent: <ThrowOnError extends boolean = false>(options: Options<ComputersFilesContentData, ThrowOnError>) => RequestResult<ComputersFilesContentResponses, ComputersFilesContentErrors, ThrowOnError>;
128
+ /**
129
+ * Connect computer
130
+ *
131
+ * Resume the computer and issue a sandbox connection.
132
+ *
133
+ * Own-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.
134
+ */
135
+ export declare const connectComputer: <ThrowOnError extends boolean = false>(options: Options<ConnectComputerData, ThrowOnError>) => RequestResult<ConnectComputerResponses, ConnectComputerErrors, ThrowOnError>;
136
+ /**
137
+ * List Toolsets
138
+ *
139
+ * Discover tool names, input schemas, read-only status and default permission policies before configuring an agent. The catalog is read-only: enable tools through agents.create or agents.update. agent_toolset_20260401 includes bash, edit, glob, grep, read, write, web_search, web_fetch, task_output, task_stop, monitor, agent, send_message, codemode and skill, plus todo_write, enter_plan_mode, ask_user_question and goal_read, which are listed so they can be switched off. Native additions require bash enabled; codemode requires bash (enabling it with bash disabled returns 400; keep bash enabled with permission_policy always_ask to restrict it); send_message also requires agent. To keep only some tools, set default_config.enabled to false and enable the wanted tools in configs; unlisted tools follow default_config. The catalog includes plugin names and versions. Sessions created through /anthropic/v1 expose only the eight official tools.
140
+ */
141
+ export declare const listToolsets: <ThrowOnError extends boolean = false>(options?: Options<ListToolsetsData, ThrowOnError>) => RequestResult<ListToolsetsResponses, ListToolsetsErrors, ThrowOnError>;
142
+ /**
143
+ * Get Session Context (Extension)
144
+ *
145
+ * Read the latest context measurement and the currently selected model’s window and compaction thresholds.
146
+ *
147
+ * Praxis extension available only on /agent/v1, following Claude Agent SDK getContextUsage() with snake_case fields. detail is summary: the latest actual model usage takes precedence, and local estimates apportion source totals; used categories sum to total_tokens. Only nonzero sources appear. Classify rows by kind (used/free/buffer/deferred). key is a stable source identifier extension; clients must tolerate unknown keys and new sources, falling back to name. MCP tools group by server, plugin blocks by id, and compaction summaries are counted separately. excluded_items is currently zero. Before measurement, total_tokens, total_tokens_source and measured_at are null, categories is empty, and details are zero or empty arrays. Model selection recalculates max_tokens, auto_compact_threshold and free/buffer while preserving the latest measurement. is_auto_compact_enabled is false for unknown capacity or a tripped compaction breaker. For example model.thinking is {efforts: [high, xhigh], can_disable: true, default_effort: high}. model.thinking contains efforts, can_disable and nullable default_effort; the entire thinking value is null when capability is unknown. Missing or inaccessible sessions return 404.
148
+ */
149
+ export declare const getSessionContext: <ThrowOnError extends boolean = false>(options: Options<GetSessionContextData, ThrowOnError>) => RequestResult<GetSessionContextResponses, GetSessionContextErrors, ThrowOnError>;
150
+ /**
151
+ * Fork Session (Extension)
152
+ *
153
+ * Create an independent session at the last assistant message of a successfully completed turn.
154
+ *
155
+ * Available only on /agent/v1. Use the message_id field from own-face events, not the event id. Copies every message and part through the target, including tool calls and results. The parent is unchanged; another running turn does not prevent forking an earlier completed turn. The new root session appears in the session list with the same agent version, current model and thinking settings, and cwd working directory. Its title is the parent title plus “ 的分支”. If the parent has a sandbox, the new session owns an independent fork including a memory snapshot. Inherited running tasks are terminated, ring targets are replaced with the new session only, and its background-task table starts empty. Without a parent sandbox, creation remains lazy. Returns 201 with the same Session shape as retrieval. forked_from is {session_id, message_id}, or null for ordinary sessions. Imported history ends with session.forked containing forked_from_session_id and forked_from_message_id. These fields and this event are own-face only. Invalid requests return 400; ineligible targets return 409 FORK_TARGET_INVALID; missing sessions or sessions belonging to another caller return 404. Initialization failures leave the child unpublished and reclaim the forked sandbox.
156
+ */
157
+ export declare const forkSession: <ThrowOnError extends boolean = false>(options: Options<ForkSessionData, ThrowOnError>) => RequestResult<ForkSessionResponses, ForkSessionErrors, ThrowOnError>;
158
+ /**
159
+ * List Session Background Tasks (Extension)
160
+ *
161
+ * List running and ended background tasks for a session.
162
+ *
163
+ * Own-face extension. Returns { data: BackgroundTask[] }. Each task has id, kind, title, thread_id, status, started_at, ended_at, cancellable, notified_at and trigger_count. Subagent rows link to their child thread via thread_id; other kinds have null. kind is an open string; tolerate unknown kinds. Status is running, result_pending, completed, failed, cancelled or lost. Only completed tasks with pending delivery are result_pending. Timestamps are RFC3339; ended_at is null while running. notified_at is the admission time of the latest system notification batch, or null. trigger_count counts admitted monitor event batches, or is null without records and for other kinds. Only supported running tasks without stop intent are cancellable. Missing or inaccessible sessions return 404.
164
+ */
165
+ export declare const listSessionBackgroundTasks: <ThrowOnError extends boolean = false>(options: Options<ListSessionBackgroundTasksData, ThrowOnError>) => RequestResult<ListSessionBackgroundTasksResponses, ListSessionBackgroundTasksErrors, ThrowOnError>;
166
+ /**
167
+ * Get Background Task Output (Extension)
168
+ *
169
+ * Read a byte page of task output without waking the sandbox.
170
+ *
171
+ * Own-face extension. offset defaults to 0; max_bytes defaults to 65536 and must be between 1 and 262144. Returns text, next_offset and eof. Offsets count UTF-8 bytes, not characters; partial trailing characters are retained for the next read. eof describes the current log, which may grow while running. A paused or missing sandbox returns empty text, the original offset, eof=true and unavailable=true, without waking it. Reading does not acknowledge model result delivery. Missing or inaccessible sessions or tasks return 404; invalid ranges return 400.
172
+ */
173
+ export declare const getSessionBackgroundTaskOutput: <ThrowOnError extends boolean = false>(options: Options<GetSessionBackgroundTaskOutputData, ThrowOnError>) => RequestResult<GetSessionBackgroundTaskOutputResponses, GetSessionBackgroundTaskOutputErrors, ThrowOnError>;
174
+ /**
175
+ * Stop Background Task (Extension)
176
+ *
177
+ * Request termination of a running task and return its current state.
178
+ *
179
+ * Own-face extension. No request body is required. Uses the same stop implementation as TaskStop: records stop_requested_at and signals the process group. Returns BackgroundTask with the same fields as the list operation. Until termination is observed, status may remain running with cancellable=false. An ended or unsupported task returns 409. Missing or inaccessible sessions or tasks return 404.
180
+ */
181
+ export declare const stopSessionBackgroundTask: <ThrowOnError extends boolean = false>(options: Options<StopSessionBackgroundTaskData, ThrowOnError>) => RequestResult<StopSessionBackgroundTaskResponses, StopSessionBackgroundTaskErrors, ThrowOnError>;
182
+ /**
183
+ * Compact Session (Extension)
184
+ *
185
+ * Request session context compaction and retrieve an operation receipt.
186
+ *
187
+ * Available only on /agent/v1. The body may be omitted or {}. Optional instructions must be a string and is forwarded unchanged. Idempotency-Key is forwarded unchanged; a UUID is generated when absent. Returns { type: session_compaction, id, status, reason? }, where id is the operation ID. queued/running return 202; skipped/succeeded/failed return 200. Non-string instructions return 400 invalid_request_error. Missing or inaccessible managed sessions return 404 not_found_error.
188
+ */
189
+ export declare const compactSession: <ThrowOnError extends boolean = false>(options: Options<CompactSessionData, ThrowOnError>) => RequestResult<CompactSessionResponses, CompactSessionErrors, ThrowOnError>;
190
+ /**
191
+ * Get Session Compaction (Extension)
192
+ *
193
+ * Read session compaction status by operation ID.
194
+ *
195
+ * Available only on /agent/v1. Returns { type: session_compaction, id, status, reason? } with HTTP 200 for every status. A missing operation or inaccessible session returns 404 not_found_error.
196
+ */
197
+ export declare const getSessionCompaction: <ThrowOnError extends boolean = false>(options: Options<GetSessionCompactionData, ThrowOnError>) => RequestResult<GetSessionCompactionResponses, GetSessionCompactionErrors, ThrowOnError>;
198
+ /**
199
+ * List Session Compactions (Extension)
200
+ *
201
+ * Read session compaction history and summaries.
202
+ *
203
+ * Available only on /agent/v1. Returns { data: [...] }. Each entry contains type, id, event_id, trigger, status, model, compacted_message_count, input_tokens_before, input_tokens_after, summary, error and created_at, as recorded by the service. Missing or inaccessible managed sessions return 404 not_found_error.
204
+ */
205
+ export declare const listSessionCompactions: <ThrowOnError extends boolean = false>(options: Options<ListSessionCompactionsData, ThrowOnError>) => RequestResult<ListSessionCompactionsResponses, ListSessionCompactionsErrors, ThrowOnError>;
206
+ /**
207
+ * Generate speech
208
+ *
209
+ * Synthesize speech from text and return the complete audio as the response body. Use it for text-to-speech; to turn audio into text use createAudioTranscription. model is a speech model such as melotts or aura-2-en (list them with listModels?type=speech). MeloTTS supports response_format wav only and takes lang (en default, fr, es, zh; ja and ko currently error) and no voice; Aura takes a native speaker name in voice (default luna) and supports mp3, opus, flac, wav and pcm (pcm is raw signed 16-bit little-endian audio at 24 kHz). Unlike OpenAI, voice names such as alloy are not aliases for Aura speakers. Non-default speed, instructions and stream_format sse are not representable and return 400 input_not_representable. No transcoding is done: when response_format is omitted the format the upstream produced is returned. Minimal request: {"model":"melotts","input":"Hello","lang":"en","response_format":"wav"}.
210
+ */
211
+ export declare const createAudioSpeech: <ThrowOnError extends boolean = false>(options: Options<CreateAudioSpeechData, ThrowOnError>) => RequestResult<CreateAudioSpeechResponses, CreateAudioSpeechErrors, ThrowOnError>;
212
+ /**
213
+ * 列出浏览器会话
214
+ *
215
+ * 分页列出当前账户的浏览器会话,按创建时刻及 ID 降序排列。可组合状态、名称、标签和用户元数据筛选;将返回的 nextCursor 原样传入以继续读取。
216
+ */
217
+ export declare const browserListSessions: <ThrowOnError extends boolean = false>(options?: Options<BrowserListSessionsData, ThrowOnError>) => RequestResult<BrowserListSessionsResponses, BrowserListSessionsErrors, ThrowOnError>;
218
+ /**
219
+ * 创建浏览器会话
220
+ *
221
+ * 创建云端 Chrome,返回自带凭证的 connectUrl。API 会话默认断开后结束;最长 6 小时。
222
+ */
223
+ export declare const browserCreateSession: <ThrowOnError extends boolean = false>(options: Options<BrowserCreateSessionData, ThrowOnError>) => RequestResult<BrowserCreateSessionResponses, BrowserCreateSessionErrors, ThrowOnError>;
224
+ /**
225
+ * 读取浏览器会话
226
+ *
227
+ * 读取当前账户的指定会话及其最新状态,sessionId 使用创建或列表返回的 id。expand=debug,events 可同时取得实时观看地址和事件首页;不存在或不属于当前账户时返回 404。
228
+ */
229
+ export declare const browserGetSession: <ThrowOnError extends boolean = false>(options: Options<BrowserGetSessionData, ThrowOnError>) => RequestResult<BrowserGetSessionResponses, BrowserGetSessionErrors, ThrowOnError>;
230
+ /**
231
+ * 关闭浏览器会话
232
+ *
233
+ * 关闭指定浏览器会话,返回关闭后的会话对象。请求体为 {"status":"REQUEST_RELEASE"};若返回 409 SESSION_INVALID_STATE,可再次读取会话确认状态;已结束的会话可重复请求关闭。
234
+ */
235
+ export declare const browserCloseSession: <ThrowOnError extends boolean = false>(options: Options<BrowserCloseSessionData, ThrowOnError>) => RequestResult<BrowserCloseSessionResponses, BrowserCloseSessionErrors, ThrowOnError>;
236
+ /**
237
+ * 读取调试地址
238
+ *
239
+ * 读取当前会话及各标签页的实时观看地址和 CDP 连接地址。直接使用返回的完整链接,保留查询凭证;会话不在运行状态时 pages 为空,返回地址不代表会话仍可连接。
240
+ */
241
+ export declare const browserGetDebug: <ThrowOnError extends boolean = false>(options: Options<BrowserGetDebugData, ThrowOnError>) => RequestResult<BrowserGetDebugResponses, BrowserGetDebugErrors, ThrowOnError>;
242
+ /**
243
+ * 列出会话事件
244
+ *
245
+ * 按事件序号升序读取指定会话的事件账本,包含生命周期和接管等事件,不包含页面点击或输入内容。可按 types 筛选,并将 nextCursor 原样传入读取后续页。
246
+ */
247
+ export declare const browserListEvents: <ThrowOnError extends boolean = false>(options: Options<BrowserListEventsData, ThrowOnError>) => RequestResult<BrowserListEventsResponses, BrowserListEventsErrors, ThrowOnError>;
248
+ /**
249
+ * 请求人工接管
250
+ *
251
+ * 为运行中的会话发起人工接管请求,返回接管请求事件。请求尚未过期或完成时,CDP 客户端的 Input.* 指令会被拒绝;再次请求会替换已有的接管说明和到期时刻。
252
+ */
253
+ export declare const browserRequestHandoff: <ThrowOnError extends boolean = false>(options: Options<BrowserRequestHandoffData, ThrowOnError>) => RequestResult<BrowserRequestHandoffResponses, BrowserRequestHandoffErrors, ThrowOnError>;
254
+ /**
255
+ * 完成人工接管
256
+ *
257
+ * 完成运行中会话的待处理人工接管,清除接管请求并返回完成事件,客户端可恢复发送 Input.* 指令。没有请求或请求已过期时返回 409 HANDOFF_NOT_PENDING。
258
+ */
259
+ export declare const browserCompleteHandoff: <ThrowOnError extends boolean = false>(options: Options<BrowserCompleteHandoffData, ThrowOnError>) => RequestResult<BrowserCompleteHandoffResponses, BrowserCompleteHandoffErrors, ThrowOnError>;
260
+ /**
261
+ * 更新查看者心跳
262
+ *
263
+ * 登记运行中会话的观看者仍在线,以免无人连接时因空闲被释放。观看页面可见期间为同一观看者重复发送相同 viewerId;停止观看后停止发送,过期心跳不再计为在线。
264
+ */
265
+ export declare const browserViewerHeartbeat: <ThrowOnError extends boolean = false>(options: Options<BrowserViewerHeartbeatData, ThrowOnError>) => RequestResult<BrowserViewerHeartbeatResponses, BrowserViewerHeartbeatErrors, ThrowOnError>;
266
+ /**
267
+ * 列出浏览器上下文
268
+ *
269
+ * 分页列出当前账户保存的登录态,按登录态 ID 升序排列。每项返回名称、标签及保存内容的统计信息;将 nextCursor 原样传入读取下一页,直到其为 null。
270
+ */
271
+ export declare const browserListContexts: <ThrowOnError extends boolean = false>(options?: Options<BrowserListContextsData, ThrowOnError>) => RequestResult<BrowserListContextsResponses, BrowserListContextsErrors, ThrowOnError>;
272
+ /**
273
+ * 创建浏览器上下文
274
+ *
275
+ * 创建空的浏览器登录态,用于在会话之间保存 cookie 和 localStorage。将返回的 id 传入 browserSettings.context.id,并设置 persist=true 才会保存会话中的更新。
276
+ */
277
+ export declare const browserCreateContext: <ThrowOnError extends boolean = false>(options: Options<BrowserCreateContextData, ThrowOnError>) => RequestResult<BrowserCreateContextResponses, BrowserCreateContextErrors, ThrowOnError>;
278
+ /**
279
+ * 删除浏览器上下文
280
+ *
281
+ * 删除当前账户的指定登录态及其保存内容,成功返回 deleted=true。登录态存在有效写入租约时返回 409 CONTEXT_LOCKED,应在写入会话结束并释放租约后重试。
282
+ */
283
+ export declare const browserDeleteContext: <ThrowOnError extends boolean = false>(options: Options<BrowserDeleteContextData, ThrowOnError>) => RequestResult<BrowserDeleteContextResponses, BrowserDeleteContextErrors, ThrowOnError>;
284
+ /**
285
+ * 读取浏览器上下文
286
+ *
287
+ * 读取当前账户的指定登录态元数据、保存内容统计及写入租约持有者,不返回 cookie 或 localStorage 内容。contextId 使用创建或列表返回的 id;不存在或不属于当前账户时返回 404。
288
+ */
289
+ export declare const browserGetContext: <ThrowOnError extends boolean = false>(options: Options<BrowserGetContextData, ThrowOnError>) => RequestResult<BrowserGetContextResponses, BrowserGetContextErrors, ThrowOnError>;
290
+ /**
291
+ * 更新浏览器上下文
292
+ *
293
+ * 更新登录态的名称和标签并返回更新后的对象,不修改已保存的 cookie 或 localStorage。省略字段保留原值;空名称清除名称,传入 labels 会整体替换标签,空对象清除标签。
294
+ */
295
+ export declare const browserUpdateContext: <ThrowOnError extends boolean = false>(options: Options<BrowserUpdateContextData, ThrowOnError>) => RequestResult<BrowserUpdateContextResponses, BrowserUpdateContextErrors, ThrowOnError>;
296
+ /**
297
+ * 连接云端浏览器
298
+ *
299
+ * CDP WebSocket:不填 session 或 name 时新开;session 连接已有会话;name 有就连接、没有就新开。session 与 name 不可同时提供。新建参数在连接已有会话时忽略。使用 Authorization: Bearer API_KEY,或直接使用创建会话返回的带 signingKey 的 connectUrl。连上后发送 CDP 命令 Praxis.getSession,获取 sessionId、liveViewUrl、consoleUrl。
300
+ */
301
+ export declare const browserConnect: <ThrowOnError extends boolean = false>(options?: Options<BrowserConnectData, ThrowOnError>) => RequestResult<unknown, BrowserConnectErrors, ThrowOnError>;
302
+ /**
303
+ * 打开实时浏览器画面
304
+ *
305
+ * 使用 debug 返回的完整实时观看地址打开浏览器画面,成功后跳转到对应会话或标签页。必须保留地址中的 t 凭证,无需额外 API Key;链接失效时重新调用 debug 获取地址。
306
+ */
307
+ export declare const browserLiveView: <ThrowOnError extends boolean = false>(options: Options<BrowserLiveViewData, ThrowOnError>) => RequestResult<unknown, BrowserLiveViewErrors, ThrowOnError>;
308
+ /**
309
+ * 订阅会话动态
310
+ *
311
+ * SSE:event 为 snapshot、session、pages、action、event 或 end,data 为对应 JSON。先发送 snapshot 快照,再推送实时变化和 ping 注释;end 后关闭。不支持按 Last-Event-ID 历史重放。
312
+ */
313
+ export declare const browserStreamSession: <ThrowOnError extends boolean = false>(options: Options<BrowserStreamSessionData, ThrowOnError, BrowserStreamSessionResponse>) => Promise<ServerSentEventsResult<BrowserStreamSessionResponses>>;
314
+ /**
315
+ * 读取 Selenium 不支持提示
316
+ *
317
+ * seleniumRemoteUrl 指向此地址;不支持 Selenium,请使用 Playwright 或 Puppeteer。
318
+ */
319
+ export declare const browserSeleniumUnsupported: <ThrowOnError extends boolean = false>(options?: Options<BrowserSeleniumUnsupportedData, ThrowOnError>) => RequestResult<unknown, BrowserSeleniumUnsupportedErrors, ThrowOnError>;
320
+ /**
321
+ * List files
322
+ *
323
+ * List live files owned by your tenant, optionally filtered by purpose or session scope_id. Results default to descending creation order with a limit of 10000. Page using after or before with a file ID from the list; these cursors are mutually exclusive. Deleted and expired files are excluded.
324
+ */
325
+ export declare const fileListFiles: <ThrowOnError extends boolean = false>(options?: Options<FileListFilesData, ThrowOnError>) => RequestResult<FileListFilesResponses, FileListFilesErrors, ThrowOnError>;
326
+ /**
327
+ * Upload file
328
+ *
329
+ * Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 104857600 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. OpenAI Uploads chunking is not supported. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–2592000), or praxis[expires_in_seconds] (3600–7776000), never both. Without expiry, the file persists until deleted.
330
+ */
331
+ export declare const fileCreateFile: <ThrowOnError extends boolean = false>(options: Options<FileCreateFileData, ThrowOnError>) => RequestResult<FileCreateFileResponses, FileCreateFileErrors, ThrowOnError>;
332
+ /**
333
+ * Delete file
334
+ *
335
+ * Delete a tenant-owned file. New metadata/content reads return not found. Already-authorized downloads may finish.
336
+ */
337
+ export declare const fileDeleteFile: <ThrowOnError extends boolean = false>(options: Options<FileDeleteFileData, ThrowOnError>) => RequestResult<FileDeleteFileResponses, FileDeleteFileErrors, ThrowOnError>;
338
+ /**
339
+ * Retrieve file
340
+ *
341
+ * Retrieve metadata for a live file owned by your tenant. Use its file_dp_ ID from upload or list. Missing, deleted, expired and other-tenant files return 404; use the content endpoint to download the bytes.
342
+ */
343
+ export declare const fileRetrieveFile: <ThrowOnError extends boolean = false>(options: Options<FileRetrieveFileData, ThrowOnError>) => RequestResult<FileRetrieveFileResponses, FileRetrieveFileErrors, ThrowOnError>;
344
+ /**
345
+ * Retrieve file content
346
+ *
347
+ * Download the original bytes of a live file owned by your tenant. Supply its file_dp_ ID from upload or list. A single byte Range can return a partial response; a range outside the file returns 416. Missing, deleted, expired and other-tenant files return 404.
348
+ */
349
+ export declare const fileRetrieveFileContent: <ThrowOnError extends boolean = false>(options: Options<FileRetrieveFileContentData, ThrowOnError>) => RequestResult<FileRetrieveFileContentResponses, FileRetrieveFileContentErrors, ThrowOnError>;
350
+ /**
351
+ * Health Check
352
+ *
353
+ * Liveness probe for the public API edge. Public, no authentication, not billed, not rate limited.
354
+ * Returns the plain text `ok` with HTTP 200 while the API worker can serve requests; any other
355
+ * status or a timeout means the edge itself is unavailable. It does not check individual
356
+ * services (model, agent, automation…); call the operation you need and read its error instead.
357
+ *
358
+ */
359
+ export declare const healthCheck: <ThrowOnError extends boolean = false>(options?: Options<HealthCheckData, ThrowOnError>) => RequestResult<HealthCheckResponses, unknown, ThrowOnError>;
360
+ /**
361
+ * Search platform methods
362
+ *
363
+ * Find the SDK / codemode method that does what you need. Public, no authentication, not billed.
364
+ * Call this before writing code against an unfamiliar capability, then call
365
+ * `GET /meta/v1/methods/{name}` for the full TypeScript declaration of the method you pick.
366
+ * Matching ignores word order and case: `list agents` and `agents list` both rank
367
+ * `praxis.agent.agents.list` first. Results are ranked by relevance over the method name,
368
+ * summary and description. Without `q`, methods are sorted by name; use `after_id` from `last_id` to retrieve the next page.
369
+ * The catalog covers platform methods (`praxis.*`) only; MCP tools of a session are not included.
370
+ *
371
+ */
372
+ export declare const metaMethodsSearch: <ThrowOnError extends boolean = false>(options?: Options<MetaMethodsSearchData, ThrowOnError>) => RequestResult<MetaMethodsSearchResponses, MetaMethodsSearchErrors, ThrowOnError>;
373
+ /**
374
+ * Retrieve a platform method
375
+ *
376
+ * Full description of one platform method: what it does, how to call it, and the complete
377
+ * TypeScript declaration of its arguments and result. Public, no authentication, not billed.
378
+ * The declaration is never truncated; copy field names and enum values from it instead of
379
+ * guessing. Take `name` from `GET /meta/v1/methods?q=<words>`. An unknown name returns 404
380
+ * METHOD_NOT_FOUND whose `hint` lists up to three similar names.
381
+ *
382
+ */
383
+ export declare const metaMethodsRetrieve: <ThrowOnError extends boolean = false>(options: Options<MetaMethodsRetrieveData, ThrowOnError>) => RequestResult<MetaMethodsRetrieveResponses, MetaMethodsRetrieveErrors, ThrowOnError>;
384
+ /**
385
+ * List Models
386
+ *
387
+ * Choose a model before making an inference call: list published ids, capabilities, supported_apis and prices without credentials. Unlike OpenAI, the catalog spans multiple protocols and includes per-unit USD prices; pricing.input and pricing.output are per token, not per million tokens, and a missing price is not zero. Filter with type=language for dialogue or type=embedding for vectors, and supported_api for the required protocol. Use each returned id unchanged, including any creator prefix; inspect tags for tools and field support for model-specific tool_choice or response_format limits. The response is the full matching catalog, not a paginated page.
388
+ */
389
+ export declare const listModels: <ThrowOnError extends boolean = false>(options?: Options<ListModelsData, ThrowOnError>) => RequestResult<ListModelsResponses, ListModelsErrors, ThrowOnError>;
390
+ /**
391
+ * Retrieve Model
392
+ *
393
+ * Read capabilities, supported_apis and per-unit prices for one model before using it. Pass an exact id returned by praxis.model.models.list, including any creator prefix such as deepseek/deepseek-v4-pro. The object is identical to its catalog entry and requires no credentials; an unknown id returns 404.
394
+ */
395
+ export declare const retrieveModel: <ThrowOnError extends boolean = false>(options: Options<RetrieveModelData, ThrowOnError>) => RequestResult<RetrieveModelResponses, RetrieveModelErrors, ThrowOnError>;
396
+ /**
397
+ * List videos
398
+ *
399
+ * OpenAI video API with OpenRouter request and response extensions.
400
+ */
401
+ export declare const listVideos: <ThrowOnError extends boolean = false>(options?: Options<ListVideosData, ThrowOnError>) => RequestResult<ListVideosResponses, ListVideosErrors, ThrowOnError>;
402
+ /**
403
+ * Create video
404
+ *
405
+ * OpenAI video API with OpenRouter request and response extensions.
406
+ */
407
+ export declare const createVideo: <ThrowOnError extends boolean = false>(options: Options<CreateVideoData, ThrowOnError>) => RequestResult<CreateVideoResponses, CreateVideoErrors, ThrowOnError>;
408
+ /**
409
+ * Delete video
410
+ *
411
+ * OpenAI video API with OpenRouter request and response extensions.
412
+ */
413
+ export declare const deleteVideo: <ThrowOnError extends boolean = false>(options: Options<DeleteVideoData, ThrowOnError>) => RequestResult<DeleteVideoResponses, DeleteVideoErrors, ThrowOnError>;
414
+ /**
415
+ * Retrieve video
416
+ *
417
+ * OpenAI video API with OpenRouter request and response extensions.
418
+ */
419
+ export declare const retrieveVideo: <ThrowOnError extends boolean = false>(options: Options<RetrieveVideoData, ThrowOnError>) => RequestResult<RetrieveVideoResponses, RetrieveVideoErrors, ThrowOnError>;
420
+ /**
421
+ * Download video
422
+ *
423
+ * OpenAI video API with OpenRouter request and response extensions.
424
+ */
425
+ export declare const downloadVideoContent: <ThrowOnError extends boolean = false>(options: Options<DownloadVideoContentData, ThrowOnError>) => RequestResult<DownloadVideoContentResponses, DownloadVideoContentErrors, ThrowOnError>;
426
+ /**
427
+ * Remix video
428
+ *
429
+ * Not supported in this release; always returns 400.
430
+ */
431
+ export declare const remixVideo: <ThrowOnError extends boolean = false>(options: Options<RemixVideoData, ThrowOnError>) => RequestResult<unknown, RemixVideoErrors, ThrowOnError>;
432
+ /**
433
+ * Transcribe audio
434
+ *
435
+ * Transcribe an uploaded audio file into text. Use it for speech-to-text; to synthesize speech use createAudioSpeech. Send multipart/form-data with model (for example whisper-large-v3-turbo or qwen3-asr-flash; list them with listModels?type=transcription) and file. response_format json (default) and text work on both models; verbose_json with segment timestamps works on whisper-large-v3-turbo only; srt and vtt return 400. Parameters a model cannot represent, such as temperature, return 400 input_not_representable, and when no model route is available the call answers 503. The response is JSON with text (plus language, duration and segments for verbose_json) or plain text for response_format text.
436
+ */
437
+ export declare const createAudioTranscription: <ThrowOnError extends boolean = false>(options: Options<CreateAudioTranscriptionData, ThrowOnError>) => RequestResult<CreateAudioTranscriptionResponses, CreateAudioTranscriptionErrors, ThrowOnError>;
438
+ /**
439
+ * Rerank documents
440
+ *
441
+ * Rank a list of documents by relevance to a query and return the best matches with scores. Use it to reorder retrieval results before you pass them to a language model; it does not generate text. Send model (a reranking model; list them with listModels?type=reranking), query and documents as an array of plain strings (object documents return 400). top_n limits how many results come back (at least 1; omit it to rank every document). Each result carries index, the zero-based position of the document in your documents array, and relevance_score from 0 to 1; results are sorted best first. Any field other than model, query, documents and top_n returns 400 input_not_representable, and 503 means no model route is available.
442
+ */
443
+ export declare const rerank: <ThrowOnError extends boolean = false>(options: Options<RerankData, ThrowOnError>) => RequestResult<RerankResponses, RerankErrors, ThrowOnError>;
444
+ /**
445
+ * Create Chat Completion
446
+ *
447
+ * OpenAI-compatible chat completions on the model domain's own face. providerOptions.praxis carries model-level fallback (models), request-level BYOK credentials (byok, falling back to platform credentials on failure), and credential-gated provider selection (order/only). Responses report providerMetadata.praxis {generationId, cost, credential, model}.
448
+ */
449
+ export declare const createChatCompletion: <ThrowOnError extends boolean = false>(options: Options<CreateChatCompletionData, ThrowOnError>) => RequestResult<CreateChatCompletionResponses, CreateChatCompletionErrors, ThrowOnError>;
450
+ /**
451
+ * Get Generation
452
+ *
453
+ * Verify the settled customer charge in USD, usage and latency for one model call. Pass the X-Praxis-Generation-Id response header or chat providerMetadata.praxis.generationId as id to praxis.model.generation.retrieve; a completion id is not a generation id. The record may take a few seconds to appear: retry a recent call's 404 shortly, without repeating the paid inference. An unknown id and another account's id also return 404; a null cost is not proof of a free call.
454
+ */
455
+ export declare const getGeneration: <ThrowOnError extends boolean = false>(options: Options<GetGenerationData, ThrowOnError>) => RequestResult<GetGenerationResponses, GetGenerationErrors, ThrowOnError>;
456
+ /**
457
+ * Create Response
458
+ *
459
+ * OpenAI Responses API on the model domain's own face (OpenAI SDK base URL …/model/v1). providerOptions.praxis is currently supported on POST /chat/completions only; sending it here answers 400.
460
+ */
461
+ export declare const createResponse: <ThrowOnError extends boolean = false>(options: Options<CreateResponseData, ThrowOnError>) => RequestResult<CreateResponseResponses, CreateResponseErrors, ThrowOnError>;
462
+ /**
463
+ * Delete Response
464
+ *
465
+ * Delete a stored response by its id when you no longer need to retrieve it. The response will no longer be available for later retrieval.
466
+ */
467
+ export declare const deleteResponse: <ThrowOnError extends boolean = false>(options: Options<DeleteResponseData, ThrowOnError>) => RequestResult<DeleteResponseResponses, unknown, ThrowOnError>;
468
+ /**
469
+ * Retrieve Response
470
+ *
471
+ * Read a stored response by its id from creation. A response created with store=false, an expired response, an unknown id or another account's response returns 404.
472
+ */
473
+ export declare const retrieveResponse: <ThrowOnError extends boolean = false>(options: Options<RetrieveResponseData, ThrowOnError>) => RequestResult<RetrieveResponseResponses, unknown, ThrowOnError>;
474
+ /**
475
+ * List Response Input Items
476
+ *
477
+ * Read the input items of a stored response using its id from creation. Use the returned items to inspect the input that produced that response.
478
+ */
479
+ export declare const listResponseInputItems: <ThrowOnError extends boolean = false>(options: Options<ListResponseInputItemsData, ThrowOnError>) => RequestResult<ListResponseInputItemsResponses, unknown, ThrowOnError>;
480
+ /**
481
+ * Cancel Response
482
+ *
483
+ * Cancel an in-progress background response using its id from creation. Unlike OpenAI, cancellation cannot guarantee that upstream compute stops; usage is settled for the output received. Repeating cancellation returns the terminal response; a synchronous response can return 400 native_responses_operation_unsupported or 404 if absent.
484
+ */
485
+ export declare const cancelResponse: <ThrowOnError extends boolean = false>(options: Options<CancelResponseData, ThrowOnError>) => RequestResult<CancelResponseResponses, CancelResponseErrors, ThrowOnError>;
486
+ /**
487
+ * Create Conversation
488
+ *
489
+ * Create a stored conversation, optionally with initial items and metadata, to reuse context across Responses calls. Pass its returned id as conversation when creating a response.
490
+ */
491
+ export declare const createConversation: <ThrowOnError extends boolean = false>(options?: Options<CreateConversationData, ThrowOnError>) => RequestResult<CreateConversationResponses, unknown, ThrowOnError>;
492
+ /**
493
+ * Delete Conversation
494
+ *
495
+ * Delete a conversation on the model domain's own face.
496
+ */
497
+ export declare const deleteConversation: <ThrowOnError extends boolean = false>(options: Options<DeleteConversationData, ThrowOnError>) => RequestResult<DeleteConversationResponses, DeleteConversationErrors, ThrowOnError>;
498
+ /**
499
+ * Retrieve Conversation
500
+ *
501
+ * Retrieve a conversation by id on the model domain's own face.
502
+ */
503
+ export declare const retrieveConversation: <ThrowOnError extends boolean = false>(options: Options<RetrieveConversationData, ThrowOnError>) => RequestResult<RetrieveConversationResponses, RetrieveConversationErrors, ThrowOnError>;
504
+ /**
505
+ * Update Conversation
506
+ *
507
+ * Replace a conversation's metadata on the model domain's own face.
508
+ */
509
+ export declare const updateConversation: <ThrowOnError extends boolean = false>(options: Options<UpdateConversationData, ThrowOnError>) => RequestResult<UpdateConversationResponses, UpdateConversationErrors, ThrowOnError>;
510
+ /**
511
+ * List Conversation Items
512
+ *
513
+ * List a conversation's items on the model domain's own face.
514
+ */
515
+ export declare const listConversationItems: <ThrowOnError extends boolean = false>(options: Options<ListConversationItemsData, ThrowOnError>) => RequestResult<ListConversationItemsResponses, ListConversationItemsErrors, ThrowOnError>;
516
+ /**
517
+ * Create Conversation Items
518
+ *
519
+ * Add items to a conversation on the model domain's own face.
520
+ */
521
+ export declare const createConversationItems: <ThrowOnError extends boolean = false>(options: Options<CreateConversationItemsData, ThrowOnError>) => RequestResult<CreateConversationItemsResponses, CreateConversationItemsErrors, ThrowOnError>;
522
+ /**
523
+ * Delete Conversation Item
524
+ *
525
+ * Delete a single conversation item on the model domain's own face.
526
+ */
527
+ export declare const deleteConversationItem: <ThrowOnError extends boolean = false>(options: Options<DeleteConversationItemData, ThrowOnError>) => RequestResult<DeleteConversationItemResponses, DeleteConversationItemErrors, ThrowOnError>;
528
+ /**
529
+ * Retrieve Conversation Item
530
+ *
531
+ * Retrieve a single conversation item on the model domain's own face.
532
+ */
533
+ export declare const retrieveConversationItem: <ThrowOnError extends boolean = false>(options: Options<RetrieveConversationItemData, ThrowOnError>) => RequestResult<RetrieveConversationItemResponses, RetrieveConversationItemErrors, ThrowOnError>;
534
+ /**
535
+ * Create Embedding
536
+ *
537
+ * OpenAI-compatible embeddings on the model domain's own face. providerOptions.praxis is currently supported on POST /chat/completions only; sending it here answers 400.
538
+ */
539
+ export declare const createEmbedding: <ThrowOnError extends boolean = false>(options: Options<CreateEmbeddingData, ThrowOnError>) => RequestResult<CreateEmbeddingResponses, CreateEmbeddingErrors, ThrowOnError>;
540
+ /**
541
+ * Create Image
542
+ *
543
+ * Generate images from a text prompt using a catalog image model. Unlike OpenAI, response_format accepts b64_json only; url returns 400. Read the selected model's support notes for sizes, quality and output format before requesting them. providerOptions.praxis is currently supported on POST /chat/completions only; sending it here answers 400.
544
+ */
545
+ export declare const createImage: <ThrowOnError extends boolean = false>(options: Options<CreateImageData, ThrowOnError>) => RequestResult<CreateImageResponses, CreateImageErrors, ThrowOnError>;
546
+ /**
547
+ * Extract document text
548
+ *
549
+ * Mistral-shaped OCR on the model domain's own face. Accepts HTTPS or base64 data URLs for documents and images. Optional features depend on the selected model; unsupported options return 400. providerOptions.praxis is currently supported on POST /chat/completions only; sending it here answers 400.
550
+ */
551
+ export declare const createOcr: <ThrowOnError extends boolean = false>(options: Options<CreateOcrData, ThrowOnError>) => RequestResult<CreateOcrResponses, CreateOcrErrors, ThrowOnError>;
552
+ /**
553
+ * Edit Image
554
+ *
555
+ * Edit one or more images from a text prompt, using multipart files or JSON data-URL images. Unlike OpenAI, mask is currently unavailable and returns 400; omit it and use a model supporting the requested size and image count. providerOptions.praxis is currently supported on POST /chat/completions only; sending it here answers 400.
556
+ */
557
+ export declare const editImage: <ThrowOnError extends boolean = false>(options: Options<EditImageData, ThrowOnError>) => RequestResult<EditImageResponses, EditImageErrors, ThrowOnError>;
558
+ /**
559
+ * Create Message
560
+ *
561
+ * Anthropic Messages API on the model domain's own face (Anthropic SDK base URL …/model; x-api-key or Bearer). providerOptions.praxis is currently supported on POST /chat/completions only; sending it here answers 400.
562
+ */
563
+ export declare const createMessage: <ThrowOnError extends boolean = false>(options: Options<CreateMessageData, ThrowOnError>) => RequestResult<CreateMessageResponses, CreateMessageErrors, ThrowOnError>;
564
+ /**
565
+ * Count Tokens
566
+ *
567
+ * Anthropic token counting on the model domain's own face. Qualified native counts are marked x-praxis-token-count=exact; bundled OpenAI text tokenization and family-calibrated request estimates are marked estimated (partial; accuracy varies by family and input type).
568
+ */
569
+ export declare const countTokens: <ThrowOnError extends boolean = false>(options: Options<CountTokensData, ThrowOnError>) => RequestResult<CountTokensResponses, CountTokensErrors, ThrowOnError>;
570
+ /**
571
+ * Compact Response
572
+ *
573
+ * Request context compaction for a response. Unlike OpenAI, this operation is unavailable and returns 501; do not use it to prepare a subsequent inference call.
574
+ */
575
+ export declare const compactResponse: <ThrowOnError extends boolean = false>(options: Options<CompactResponseData, ThrowOnError>) => RequestResult<CompactResponseResponses, CompactResponseErrors, ThrowOnError>;
576
+ /**
577
+ * Count Response Input Tokens
578
+ *
579
+ * Request an input-token count for Responses input. Unlike OpenAI, this operation is unavailable and returns 501; use the documented Messages token-count operation only when its input shape and estimation limits fit your task.
580
+ */
581
+ export declare const countResponseInputTokens: <ThrowOnError extends boolean = false>(options: Options<CountResponseInputTokensData, ThrowOnError>) => RequestResult<CountResponseInputTokensResponses, CountResponseInputTokensErrors, ThrowOnError>;
582
+ /**
583
+ * Report a problem with the Praxis platform
584
+ *
585
+ * Report a problem with the Praxis platform when an API fails, documentation is unclear, or a capability is missing. AI callers in codemode should include the original error text in message, the X-Request-Id or error event ID in associated_event_id, and relevant session, agent, model, or request IDs in contexts. Continue the user's task after reporting. Each successful call stores feedback and returns its id; repeated calls create separate reports. The authenticated principal determines the reporter; any reporter supplied in the body is ignored. Machine tokens force source to codemode. Requires a valid API key, Console session, or machine token. Minimal body: {"message":"The API documentation does not explain this error."}.
586
+ */
587
+ export declare const createOrganizationFeedback: <ThrowOnError extends boolean = false>(options: Options<CreateOrganizationFeedbackData, ThrowOnError>) => RequestResult<CreateOrganizationFeedbackResponses, CreateOrganizationFeedbackErrors, ThrowOnError>;
588
+ /**
589
+ * List Organization Costs
590
+ *
591
+ * Billed cost per time bucket per group (AWS GetCostAndUsage shape). Buckets are whole UTC hour/day periods; a window is answered over the aligned envelope covering it. Amounts are exact decimal strings in the currency the organization was charged in (BillingCurrency, CNY or USD); a group charged in two currencies is two results. estimated is always false: charges are final when they are recorded. Windows span at most 93 days; longer ranges belong to the charges export.
592
+ *
593
+ */
594
+ export declare const listOrganizationCosts: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationCostsData, ThrowOnError>) => RequestResult<ListOrganizationCostsResponses, ListOrganizationCostsErrors, ThrowOnError>;
595
+ /**
596
+ * List Organization Usage
597
+ *
598
+ * Consumed quantity per time bucket per group. Buckets are whole UTC hour/day periods covering the requested window. Each result carries exactly one ConsumedQuantity + ConsumedUnit — quantities of different units are never added together.
599
+ *
600
+ */
601
+ export declare const listOrganizationUsage: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationUsageData, ThrowOnError>) => RequestResult<ListOrganizationUsageResponses, ListOrganizationUsageErrors, ThrowOnError>;
602
+ /**
603
+ * List Organization Usage Events
604
+ *
605
+ * Usage events newest first, one opaque cursor page at a time; a page never duplicates or skips an event. Every item carries its metering lines (meter, display name, consumed quantity and unit, mapped from the billing measurements); the per-line price split (list unit price, pricing unit, billed cost) rides only the single event — fetch /organization/v1/events/{id} for it.
606
+ *
607
+ */
608
+ export declare const listOrganizationEvents: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationEventsData, ThrowOnError>) => RequestResult<ListOrganizationEventsResponses, ListOrganizationEventsErrors, ThrowOnError>;
609
+ /**
610
+ * Get One Organization Usage Event
611
+ *
612
+ * One event with its usage line (meter display name, consumed quantity and unit, billed cost; ListUnitPrice and PricingUnit are null because billing prices an event as a whole), its settlement status and x_Charges, the transactions that paid it (promotional balance is taken before cash). A nonexistent id and another organization's id are indistinguishable: both answer the same 404 problem body except X-Request-Id.
613
+ *
614
+ */
615
+ export declare const getOrganizationEvent: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationEventData, ThrowOnError>) => RequestResult<GetOrganizationEventResponses, GetOrganizationEventErrors, ThrowOnError>;
616
+ /**
617
+ * Export Organization Charges
618
+ *
619
+ * FOCUS 1.3 subset export, one JSON record per line (application/x-ndjson), one record per usage event, paginating the window day by day server-side. The sum of BilledCost over all lines equals the costs endpoint's total for the same window.
620
+ *
621
+ */
622
+ export declare const exportOrganizationCharges: <ThrowOnError extends boolean = false>(options: Options<ExportOrganizationChargesData, ThrowOnError>) => RequestResult<ExportOrganizationChargesResponses, ExportOrganizationChargesErrors, ThrowOnError>;
623
+ /**
624
+ * Upgrade to a full sandbox
625
+ *
626
+ * Move a light sandbox to a full environment when its capabilities are insufficient. Stops active processes and terminals, migrates files, and preserves the sandbox ID and name. Reconnect with the new envdAccessToken. A failed migration preserves source files but does not restart terminated processes.
627
+ */
628
+ export declare const upgradeSandbox: <ThrowOnError extends boolean = false>(options: Options<UpgradeSandboxData, ThrowOnError>) => RequestResult<UpgradeSandboxResponses, UpgradeSandboxErrors, ThrowOnError>;
629
+ /**
630
+ * Extend a running sandbox without shortening its deadline
631
+ *
632
+ * Extend a running sandbox only when it needs a later expiry; this never resumes a paused sandbox. Timeout is seconds from now, not added to the prior deadline, and must be 900, 1800 or 3600. Returns 409 for paused, expired, or non-extending requests.
633
+ */
634
+ export declare const extendSandbox: <ThrowOnError extends boolean = false>(options: Options<ExtendSandboxData, ThrowOnError>) => RequestResult<ExtendSandboxResponses, ExtendSandboxErrors, ThrowOnError>;
635
+ /**
636
+ * List live processes and retained observations
637
+ *
638
+ * Inspect live processes and retained observations; this does not start a command. Praxis observation, not complete provider history. Only a witnessed exit event establishes exitCode; disconnects and restarts leave gaps and unknown state. Output retains at most 1 MiB/1024 chunks per process and 4 MiB/4096 chunks per instance across 256 observations. Truncation is explicit. Output data is base64; timestamps are Unix milliseconds. Reading never resumes a paused sandbox.
639
+ */
640
+ export declare const listObservedProcesses: <ThrowOnError extends boolean = false>(options: Options<ListObservedProcessesData, ThrowOnError>) => RequestResult<ListObservedProcessesResponses, ListObservedProcessesErrors, ThrowOnError>;
641
+ /**
642
+ * Read bounded observed process output
643
+ *
644
+ * Read retained stdout and stderr chunks for a processID returned by processes.list. Praxis observation, not complete provider history. Only a witnessed exit event establishes exitCode; disconnects and restarts leave gaps and unknown state. Output retains at most 1 MiB/1024 chunks per process and 4 MiB/4096 chunks per instance across 256 observations. Truncation is explicit. Output data is base64; timestamps are Unix milliseconds. Reading never resumes a paused sandbox.
645
+ */
646
+ export declare const getObservedProcessOutput: <ThrowOnError extends boolean = false>(options: Options<GetObservedProcessOutputData, ThrowOnError>) => RequestResult<GetObservedProcessOutputResponses, GetObservedProcessOutputErrors, ThrowOnError>;
647
+ /**
648
+ * Kill sandbox
649
+ *
650
+ * Kill a sandbox: stop it and release its resources for good. Use it when you are done with the sandbox; to keep its state for later use pause it instead with pauseSandbox. Success answers 204 with no body, and a killed sandbox answers 404 afterwards.
651
+ */
652
+ export declare const deleteSandboxV1SandboxesBySandboxId: <ThrowOnError extends boolean = false>(options: Options<DeleteSandboxV1SandboxesBySandboxIdData, ThrowOnError>) => RequestResult<DeleteSandboxV1SandboxesBySandboxIdResponses, DeleteSandboxV1SandboxesBySandboxIdErrors, ThrowOnError>;
653
+ /**
654
+ * Sandbox
655
+ *
656
+ * Read one sandbox: its state (running or paused), template, resources, start time and expiry (endAt), plus the access token for its data plane when it is running. Use it to poll the state or the remaining lifetime of a sandbox; to find sandboxes use listSandboxes. An unknown id or another team's sandbox answers 404.
657
+ */
658
+ export declare const getSandboxV1SandboxesBySandboxId: <ThrowOnError extends boolean = false>(options: Options<GetSandboxV1SandboxesBySandboxIdData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesBySandboxIdResponses, GetSandboxV1SandboxesBySandboxIdErrors, ThrowOnError>;
659
+ /**
660
+ * Rename a sandbox
661
+ *
662
+ * Rename your sandbox. Names are trimmed, must contain 1–64 characters after trimming, and must be unique within your team. Only name may be changed. Returns the updated sandbox detail, as GET does. Killed or unavailable sandboxes return 404.
663
+ */
664
+ export declare const renameSandbox: <ThrowOnError extends boolean = false>(options: Options<RenameSandboxData, ThrowOnError>) => RequestResult<RenameSandboxResponses, RenameSandboxErrors, ThrowOnError>;
665
+ /**
666
+ * Remove a file or directory in the sandbox
667
+ *
668
+ * Remove an unneeded file or recursively remove a directory and its contents. This permanently deletes the selected path; read any needed content first. Returns 204 after removal.
669
+ */
670
+ export declare const removeSandboxFile: <ThrowOnError extends boolean = false>(options: Options<RemoveSandboxFileData, ThrowOnError>) => RequestResult<RemoveSandboxFileResponses, RemoveSandboxFileErrors, ThrowOnError>;
671
+ /**
672
+ * Read a file in the sandbox
673
+ *
674
+ * Read UTF-8 file content when a command needs input or produced a text artifact. Returns a JSON string. Unlike E2B, this endpoint supports text only and rejects output above 1 MiB; binary and streaming reads are unavailable.
675
+ */
676
+ export declare const readSandboxFile: <ThrowOnError extends boolean = false>(options: Options<ReadSandboxFileData, ThrowOnError>) => RequestResult<ReadSandboxFileResponses, ReadSandboxFileErrors, ThrowOnError>;
677
+ /**
678
+ * Write a file in the sandbox
679
+ *
680
+ * Write a file in the sandbox before running a command. Replaces the target content and creates missing parent directories. Unlike E2B, this endpoint accepts one UTF-8 text file per request, at most 1 MiB; binary and batch writes are unavailable. Example body: {"path":"/tmp/hello.txt","data":"hello"}.
681
+ */
682
+ export declare const writeSandboxFile: <ThrowOnError extends boolean = false>(options: Options<WriteSandboxFileData, ThrowOnError>) => RequestResult<WriteSandboxFileResponses, WriteSandboxFileErrors, ThrowOnError>;
683
+ /**
684
+ * List files in a sandbox directory
685
+ *
686
+ * Inspect a directory to find paths to read or remove. Returns immediate children with name, path, type and size. Unlike E2B, recursive depth is unavailable and responses are limited to 1 MiB.
687
+ */
688
+ export declare const listSandboxFiles: <ThrowOnError extends boolean = false>(options: Options<ListSandboxFilesData, ThrowOnError>) => RequestResult<ListSandboxFilesResponses, ListSandboxFilesErrors, ThrowOnError>;
689
+ /**
690
+ * Create a directory in the sandbox
691
+ *
692
+ * Create a directory and missing parent directories before writing files. Returns true when created or false when the path already exists. Supply the path as a query parameter.
693
+ */
694
+ export declare const makeSandboxDirectory: <ThrowOnError extends boolean = false>(options: Options<MakeSandboxDirectoryData, ThrowOnError>) => RequestResult<MakeSandboxDirectoryResponses, MakeSandboxDirectoryErrors, ThrowOnError>;
695
+ /**
696
+ * Run a command in the sandbox
697
+ *
698
+ * Execute a shell command and wait for stdout, stderr and exitCode. Supply cmd, optional cwd and envs, and timeoutMs (1–60000 milliseconds, default 60000). Unlike E2B, this endpoint is synchronous only: no background mode, callbacks or unlimited timeout; output is bounded to 1 MiB including stream framing. Nonzero exit codes return 200 with the result. A timeout returns COMMAND_TIMEOUT (504); transport timeout does not confirm process termination, so do not blindly retry commands with side effects. Example body: {"cmd":"echo hi"}.
699
+ */
700
+ export declare const runSandboxCommand: <ThrowOnError extends boolean = false>(options: Options<RunSandboxCommandData, ThrowOnError>) => RequestResult<RunSandboxCommandResponses, RunSandboxCommandErrors, ThrowOnError>;
701
+ /**
702
+ * List agents
703
+ *
704
+ * List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=service for per-session environments. Pass next_page from the response as page to read the next page; a null next_page means the end.
705
+ */
706
+ export declare const agentsList: <ThrowOnError extends boolean = false>(options?: Options<AgentsListData, ThrowOnError>) => RequestResult<AgentsListResponses, unknown, ThrowOnError>;
707
+ /**
708
+ * Create agent
709
+ *
710
+ * Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. Unlike Anthropic Managed Agents, nonempty skills attachments and custom tool entries return 400; the native skill tool is separate from the skills field. Use tools: [{type: "agent_toolset_20260401"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: "agent_toolset_20260401", default_config: {enabled: false}, configs: [{name: "codemode", enabled: true}, {name: "bash", enabled: true, permission_policy: {type: "always_ask"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. Example: {"name":"helper","model":{"id":"deepseek-flash"},"tools":[{"type":"agent_toolset_20260401"}]}.
711
+ */
712
+ export declare const agentsCreate: <ThrowOnError extends boolean = false>(options: Options<AgentsCreateData, ThrowOnError>) => RequestResult<AgentsCreateResponses, unknown, ThrowOnError>;
713
+ /**
714
+ * Get agent
715
+ *
716
+ * Read one agent by id, at its latest version or, with version, at a specific earlier version. The response lists every native tool with its resolved configuration in one agent_toolset_20260401 entry, so it can be sent back unchanged to agents.update. Use agents.versions.list to enumerate versions.
717
+ */
718
+ export declare const agentsRetrieve: <ThrowOnError extends boolean = false>(options: Options<AgentsRetrieveData, ThrowOnError>) => RequestResult<AgentsRetrieveResponses, unknown, ThrowOnError>;
719
+ /**
720
+ * Update agent
721
+ *
722
+ * Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version; existing sessions keep the version they were created with. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. Unlike Anthropic Managed Agents, nonempty skills attachments and custom tools return 400; use the native skill tool for available runtime skills.
723
+ */
724
+ export declare const agentsUpdate: <ThrowOnError extends boolean = false>(options: Options<AgentsUpdateData, ThrowOnError>) => RequestResult<AgentsUpdateResponses, unknown, ThrowOnError>;
725
+ /**
726
+ * Archive agent
727
+ *
728
+ * Archive an agent so it can no longer be updated and no new session can be created from it (AGENT_ARCHIVED). The agent and all of its versions stay readable. Use it to retire an agent you no longer want to run; it does not delete anything.
729
+ */
730
+ export declare const agentsArchive: <ThrowOnError extends boolean = false>(options: Options<AgentsArchiveData, ThrowOnError>) => RequestResult<AgentsArchiveResponses, unknown, ThrowOnError>;
731
+ /**
732
+ * List agent versions
733
+ *
734
+ * List the saved versions of one agent, in pages of at most 100 (default 20). Each item is the full agent definition at that version, so you can compare what changed between versions. Use agents.retrieve with version to read a single one; agent_id comes from agents.list or agents.create.
735
+ */
736
+ export declare const agentsVersionsList: <ThrowOnError extends boolean = false>(options: Options<AgentsVersionsListData, ThrowOnError>) => RequestResult<AgentsVersionsListResponses, unknown, ThrowOnError>;
737
+ /**
738
+ * List sessions
739
+ *
740
+ * List sessions of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Unlike Anthropic Managed Agents, only limit, page, agent_id and deployment_id are honored; the other filters declared here (agent_version, created_at ranges, memory_store_id, include_archived, order, statuses) are not supported and return 400. Use the returned id with sessions.retrieve or sessions.events.list; pass next_page as page for the next page.
741
+ */
742
+ export declare const sessionsList: <ThrowOnError extends boolean = false>(options?: Options<SessionsListData, ThrowOnError>) => RequestResult<SessionsListResponses, unknown, ThrowOnError>;
743
+ /**
744
+ * Create session
745
+ *
746
+ * Create a session: one conversation with an agent, running on a machine. Pass agent as an agent id (latest version) or {id, version, type:"agent"}. Unlike Anthropic Managed Agents, omit environment_id to get a light machine, unless computer_id (explicit, or the agent's default) selects a Computer; pass environment_id for a sandbox recipe. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Inline agent overrides are not supported. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Omitted budget defaults to USD 20; null removes the limit, and a limit object uses a positive integer string of USD cents. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.
747
+ */
748
+ export declare const sessionsCreate: <ThrowOnError extends boolean = false>(options: Options<SessionsCreateData, ThrowOnError>) => RequestResult<SessionsCreateResponses, unknown, ThrowOnError>;
749
+ /**
750
+ * Get session
751
+ *
752
+ * Read one session by id: its agent snapshot, status, model and thinking selection, resources, title, metadata and, for a fork, forked_from. Use it to poll status; to read what happened use sessions.events.list. This response does not include a machine object or sandbox id. With no environment_id or Computer selected at creation, the session starts on a light machine; no environment lookup or provisioning is needed for a codemode calculation.
753
+ */
754
+ export declare const sessionsRetrieve: <ThrowOnError extends boolean = false>(options: Options<SessionsRetrieveData, ThrowOnError>) => RequestResult<SessionsRetrieveResponses, unknown, ThrowOnError>;
755
+ /**
756
+ * Update session
757
+ *
758
+ * Update a session's title, metadata, model or thinking selection. metadata follows patch semantics: a string value sets the key, null deletes it, a null metadata clears all keys, untouched keys stay. model must be allowed by the session's agent version; thinking is {effort} or null (null restores inheritance); a model-only change clears a session thinking that the new model does not support, and combined changes are validated against the new model, with the previous selection kept on a 400. Changes apply from the next turn, not to a turn already running. Agent overrides are not supported (400 naming the field). Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. A budget limit must exceed consumed cost; null removes it permanently for this session. Updating an archived session returns 409.
759
+ */
760
+ export declare const sessionsUpdate: <ThrowOnError extends boolean = false>(options: Options<SessionsUpdateData, ThrowOnError>) => RequestResult<SessionsUpdateResponses, unknown, ThrowOnError>;
761
+ /**
762
+ * Archive session
763
+ *
764
+ * Archive a session. An archived session refuses new messages with 400 invalid_request_error, while its details and event history stay readable. Archiving again is idempotent and archived_at keeps the first archive time. Use it when a conversation is finished; it does not delete anything.
765
+ */
766
+ export declare const sessionsArchive: <ThrowOnError extends boolean = false>(options: Options<SessionsArchiveData, ThrowOnError>) => RequestResult<SessionsArchiveResponses, unknown, ThrowOnError>;
767
+ /**
768
+ * List session events
769
+ *
770
+ * Read the event history of a session as a page of events, oldest first by default (order=desc for newest first). Use it after sending a message to collect the reply, to find tool calls that wait for approval (session.status_idle with stop_reason requires_action lists their event_ids), or to audit a run; to follow a running session live use sessions.events.stream instead. Filter by types and by a created_at range on processed_at; pages hold at most 100 events (default 20) and next_page continues. A failed run emits session.error before session.status_terminated. Native history also includes user.steer, user.withdraw, system.notification, session.forked, session.goal_changed and session.goal_verification; these are not accepted by the /anthropic/v1 event-type filter.
771
+ */
772
+ export declare const sessionsEventsList: <ThrowOnError extends boolean = false>(options: Options<SessionsEventsListData, ThrowOnError>) => RequestResult<SessionsEventsListResponses, unknown, ThrowOnError>;
773
+ /**
774
+ * Send session events
775
+ *
776
+ * Send events to a session: user.message (exactly one nonempty text block), user.interrupt, user.tool_confirmation to allow or deny a pending tool call, user.steer to inject a queued user.message into a turn that is still running, and user.withdraw to retract a queued message. The response only acknowledges the inputs; read replies with sessions.events.list or sessions.events.stream. A message sent while the session waits for tool approval is queued (processed_at null) and runs in order after the approval is resolved. Archived sessions reject new messages. To approve, read a pending agent.tool_use or agent.mcp_tool_use event and send {type: "user.tool_confirmation", tool_use_id: <that event id>, result: "allow"} (or deny); include session_thread_id for a child approval. Native confirmations also accept updated_permissions, answers and annotations, which /anthropic/v1 rejects.
777
+ */
778
+ export declare const sessionsEventsSend: <ThrowOnError extends boolean = false>(options: Options<SessionsEventsSendData, ThrowOnError>) => RequestResult<SessionsEventsSendResponses, unknown, ThrowOnError>;
779
+ /**
780
+ * Stream session events
781
+ *
782
+ * Open a Server-Sent Events stream of a session's events in real time. Use it to show a reply as it is produced; to read past events use sessions.events.list. Send a message through sessions.events.send in another request while the stream is open. Closing the stream only drops your subscription and does not stop the agent. Pass event_deltas[]=agent.message, agent.thinking or agent.tool_use to also receive event_start / event_delta previews before the final event.
783
+ */
784
+ export declare const sessionsEventsStream: <ThrowOnError extends boolean = false>(options: Options<SessionsEventsStreamData, ThrowOnError, SessionsEventsStreamResponse>) => Promise<ServerSentEventsResult<SessionsEventsStreamResponses>>;
785
+ /**
786
+ * List session threads
787
+ *
788
+ * List the execution threads of a session: the primary thread plus every child thread started by subagents or advisors, in created_at order. Child threads reference the primary through parent_thread_id. Pages hold at most 100 threads (default 20). Use a thread id with sessions.threads.retrieve, sessions.threads.events.list or sessions.threads.events.stream.
789
+ */
790
+ export declare const sessionsThreadsList: <ThrowOnError extends boolean = false>(options: Options<SessionsThreadsListData, ThrowOnError>) => RequestResult<SessionsThreadsListResponses, unknown, ThrowOnError>;
791
+ /**
792
+ * Get session thread
793
+ *
794
+ * Read one execution thread of a session, field for field the same as its list item. Thread ids that are unknown, malformed or belong to another session all return 404, so existence is not revealed. thread_id comes from sessions.threads.list or from the session_thread_id of a session.thread_created event.
795
+ */
796
+ export declare const sessionsThreadsRetrieve: <ThrowOnError extends boolean = false>(options: Options<SessionsThreadsRetrieveData, ThrowOnError>) => RequestResult<SessionsThreadsRetrieveResponses, unknown, ThrowOnError>;
797
+ /**
798
+ * Archive session thread
799
+ *
800
+ * Archive one execution thread. Archiving the primary thread archives the session; archiving a child archives only that child, leaving the parent and its siblings untouched. An archived child has status terminated and archived_at set, receives no new events and keeps its history readable.
801
+ */
802
+ export declare const sessionsThreadsArchive: <ThrowOnError extends boolean = false>(options: Options<SessionsThreadsArchiveData, ThrowOnError>) => RequestResult<SessionsThreadsArchiveResponses, unknown, ThrowOnError>;
803
+ /**
804
+ * List session thread events
805
+ *
806
+ * Read the event history of one execution thread: the session itself for the primary thread, or the child session for a child thread. It accepts the same filters, ordering and paging as sessions.events.list and returns the same data + next_page envelope. Child approvals carry session_thread_id so you can route a confirmation to the owning thread.
807
+ */
808
+ export declare const sessionsThreadsEventsList: <ThrowOnError extends boolean = false>(options: Options<SessionsThreadsEventsListData, ThrowOnError>) => RequestResult<SessionsThreadsEventsListResponses, unknown, ThrowOnError>;
809
+ /**
810
+ * Stream session thread events
811
+ *
812
+ * Open a Server-Sent Events stream of one execution thread's live events, using the same implementation as sessions.events.stream; a read-only WebSocket is also available on this path. The parent session stream additionally carries child creation, status and message events. Pass event_deltas[]=agent.message, agent.thinking or agent.tool_use for incremental previews.
813
+ */
814
+ export declare const sessionsThreadsEventsStream: <ThrowOnError extends boolean = false>(options: Options<SessionsThreadsEventsStreamData, ThrowOnError, SessionsThreadsEventsStreamResponse>) => Promise<ServerSentEventsResult<SessionsThreadsEventsStreamResponses>>;
815
+ /**
816
+ * Get environment
817
+ *
818
+ * Read one environment's configuration and status by id. Built-in environments are readable but never editable; tenant-owned ones can be updated or archived. environment_id comes from environments.list or environments.create.
819
+ */
820
+ export declare const environmentsRetrieve: <ThrowOnError extends boolean = false>(options: Options<EnvironmentsRetrieveData, ThrowOnError>) => RequestResult<EnvironmentsRetrieveResponses, unknown, ThrowOnError>;
821
+ /**
822
+ * Update environment
823
+ *
824
+ * Update the configuration of a tenant-owned cloud environment. Built-in environments are read-only. Package installation and limited networking are applied when a session's sandbox is created. Omitted fields keep their value.
825
+ */
826
+ export declare const environmentsUpdate: <ThrowOnError extends boolean = false>(options: Options<EnvironmentsUpdateData, ThrowOnError>) => RequestResult<EnvironmentsUpdateResponses, unknown, ThrowOnError>;
827
+ /**
828
+ * Archive environment
829
+ *
830
+ * Soft-archive a tenant-owned cloud environment so it can no longer be used to create new sessions. Built-in environments are read-only and cannot be archived.
831
+ */
832
+ export declare const environmentsArchive: <ThrowOnError extends boolean = false>(options: Options<EnvironmentsArchiveData, ThrowOnError>) => RequestResult<EnvironmentsArchiveResponses, unknown, ThrowOnError>;
833
+ /**
834
+ * List environments
835
+ *
836
+ * List execution environments: the built-in recipes and the tenant-owned cloud environments that a session can run in. Archived environments are hidden unless include_archived is true. Pages hold at most 100 items (default 20); pass next_page as page to continue. Use the returned id as environment_id when creating a session.
837
+ */
838
+ export declare const environmentsList: <ThrowOnError extends boolean = false>(options?: Options<EnvironmentsListData, ThrowOnError>) => RequestResult<EnvironmentsListResponses, unknown, ThrowOnError>;
839
+ /**
840
+ * Create environment
841
+ *
842
+ * Create a tenant-owned cloud environment: a sandbox recipe (packages to install and networking policy) that sessions can select through environment_id. Package installation happens when the session's sandbox is created; a failed install terminates that session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. Limited networking is applied at sandbox creation. Unlike Anthropic Managed Agents, self_hosted environments, scope and cross-session package caching are not supported.
843
+ */
844
+ export declare const environmentsCreate: <ThrowOnError extends boolean = false>(options: Options<EnvironmentsCreateData, ThrowOnError>) => RequestResult<EnvironmentsCreateResponses, unknown, ThrowOnError>;
845
+ /**
846
+ * List session resources
847
+ *
848
+ * List the extra resources (file references) attached to a session, oldest first, at most 1000 per page (default 1000). Use the returned id with sessions.resources.retrieve or sessions.resources.delete; next_page continues a truncated list.
849
+ */
850
+ export declare const sessionsResourcesList: <ThrowOnError extends boolean = false>(options: Options<SessionsResourcesListData, ThrowOnError>) => RequestResult<SessionsResourcesListResponses, unknown, ThrowOnError>;
851
+ /**
852
+ * Add session resource
853
+ *
854
+ * Attach a file resource to a session by file_id, up to 500 per session. The file must exist and belong to your tenant. It is mounted under /mnt/session/uploads/<file_id> unless mount_path is given; custom paths are rooted there and parent traversal is rejected. File content is immutable through this API, and synchronizing it into a running sandbox is not implemented in this version.
855
+ */
856
+ export declare const sessionsResourcesAdd: <ThrowOnError extends boolean = false>(options: Options<SessionsResourcesAddData, ThrowOnError>) => RequestResult<SessionsResourcesAddResponses, unknown, ThrowOnError>;
857
+ /**
858
+ * Delete session resource
859
+ *
860
+ * Detach a resource from a session. Only the reference is removed; the underlying file is not deleted. The response is {id, type: session_resource_deleted}. resource_id comes from sessions.resources.list or the add call.
861
+ */
862
+ export declare const sessionsResourcesDelete: <ThrowOnError extends boolean = false>(options: Options<SessionsResourcesDeleteData, ThrowOnError>) => RequestResult<SessionsResourcesDeleteResponses, unknown, ThrowOnError>;
863
+ /**
864
+ * Get session resource
865
+ *
866
+ * Read one resource attached to a session: its type, file_id, mount_path and timestamps. resource_id comes from sessions.resources.list or sessions.resources.add.
867
+ */
868
+ export declare const sessionsResourcesRetrieve: <ThrowOnError extends boolean = false>(options: Options<SessionsResourcesRetrieveData, ThrowOnError>) => RequestResult<SessionsResourcesRetrieveResponses, unknown, ThrowOnError>;
869
+ /**
870
+ * List deployments
871
+ *
872
+ * List stored deployments newest first. Filter by agent_id, status, or inclusive created_at bounds; status and include_archived cannot be combined, even when include_archived is false. The default limit is 20, maximum 100; pass next_page as page to continue. Archived deployments are hidden by default. Schedules show up to five future wall-clock occurrences, also while paused; archived schedules show none.
873
+ */
874
+ export declare const deploymentsList: <ThrowOnError extends boolean = false>(options?: Options<DeploymentsListData, ThrowOnError>) => RequestResult<DeploymentsListResponses, unknown, ThrowOnError>;
875
+ /**
876
+ * Create deployment
877
+ *
878
+ * Freeze session parameters as a deployment; this operation does not open a session. Pass an agent id or versioned reference, a name, 1–50 user.message initial events and an environment_id from environments.list. Unlike Anthropic Managed Agents, /agent/v1 also accepts agent_with_overrides (model, permission_mode and cwd) and target=computer for personal agents, with environment_id omitted. Cron schedules use five POSIX fields and an IANA timezone. File resources are accepted. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Active schedules run every minute when due; session creation errors pause the deployment. Unsupported tools, mcp_servers, system and skills overrides return 400.
879
+ */
880
+ export declare const deploymentsCreate: <ThrowOnError extends boolean = false>(options: Options<DeploymentsCreateData, ThrowOnError>) => RequestResult<DeploymentsCreateResponses, unknown, ThrowOnError>;
881
+ /**
882
+ * Get deployment
883
+ *
884
+ * Read a stored deployment by its depl_ id from deployments.create or deployments.list. The agent reference has a concrete version; own-face overrides are echoed unchanged. This read recomputes upcoming schedule times and does not execute the deployment. Foreign or absent ids return 404.
885
+ */
886
+ export declare const deploymentsRetrieve: <ThrowOnError extends boolean = false>(options: Options<DeploymentsRetrieveData, ThrowOnError>) => RequestResult<DeploymentsRetrieveResponses, unknown, ThrowOnError>;
887
+ /**
888
+ * Update deployment
889
+ *
890
+ * Partially update a deployment. Omitted fields keep their values; a supplied agent id re-pins the latest version, or supply a versioned reference. Metadata merges string values and deletes keys set to null. Null clears schedule, resources and description; name, environment_id and initial_events cannot be cleared. Archived deployments return 409. Overrides apply to new sessions; updating a schedule recalculates its next occurrence.
891
+ */
892
+ export declare const deploymentsUpdate: <ThrowOnError extends boolean = false>(options: Options<DeploymentsUpdateData, ThrowOnError>) => RequestResult<DeploymentsUpdateResponses, unknown, ThrowOnError>;
893
+ /**
894
+ * Archive deployment
895
+ *
896
+ * Archive a deployment by its depl_ id. Repeated calls are idempotent; archived deployments remain readable and have no upcoming schedule times. Subsequent update, pause and unpause calls return 409. This operation does not create a deployment run.
897
+ */
898
+ export declare const deploymentsArchive: <ThrowOnError extends boolean = false>(options: Options<DeploymentsArchiveData, ThrowOnError>) => RequestResult<DeploymentsArchiveResponses, unknown, ThrowOnError>;
899
+ /**
900
+ * Pause deployment
901
+ *
902
+ * Pause an active deployment and set paused_reason to {type: manual}. Repeated pause calls are idempotent; archived deployments return 409. Upcoming schedule times remain visible while paused; no run is executed.
903
+ */
904
+ export declare const deploymentsPause: <ThrowOnError extends boolean = false>(options: Options<DeploymentsPauseData, ThrowOnError>) => RequestResult<DeploymentsPauseResponses, unknown, ThrowOnError>;
905
+ /**
906
+ * Unpause deployment
907
+ *
908
+ * Resume a paused deployment and clear paused_reason. Repeated unpause calls on an active deployment are idempotent; archived deployments return 409. This operation changes resource state only and does not execute a run.
909
+ */
910
+ export declare const deploymentsUnpause: <ThrowOnError extends boolean = false>(options: Options<DeploymentsUnpauseData, ThrowOnError>) => RequestResult<DeploymentsUnpauseResponses, unknown, ThrowOnError>;
911
+ /**
912
+ * List deployment runs
913
+ *
914
+ * List deployment runs newest first. Filter by deployment_id, has_error, trigger_type (manual or schedule) and created_at[gt|gte|lt|lte]. The default limit is 20, maximum 100; pass next_page as page with the same filters to continue. Each record identifies the resolved agent version and either its session or creation error.
915
+ */
916
+ export declare const deploymentRunsList: <ThrowOnError extends boolean = false>(options?: Options<DeploymentRunsListData, ThrowOnError>) => RequestResult<DeploymentRunsListResponses, unknown, ThrowOnError>;
917
+ /**
918
+ * Get deployment run
919
+ *
920
+ * Read a deployment run by the drun_ id returned by deployments.run or deployment_runs.list. Exactly one of session_id and error is non-null. Scheduled runs include scheduled_at in trigger_context. Foreign or absent ids return 404.
921
+ */
922
+ export declare const deploymentRunsRetrieve: <ThrowOnError extends boolean = false>(options: Options<DeploymentRunsRetrieveData, ThrowOnError>) => RequestResult<DeploymentRunsRetrieveResponses, unknown, ThrowOnError>;
923
+ /**
924
+ * Run deployment
925
+ *
926
+ * Create one session from an active deployment using its pinned agent version and stored parameters. Pass the depl_ id from deployments.create or deployments.list; no request body is needed. Returns a drun_ record with exactly one of session_id or error populated. Creation errors automatically pause the deployment; paused or archived deployments return 409 without a run. Unlike the own face, the compatible face rejects computer targets with 400.
927
+ */
928
+ export declare const deploymentsRun: <ThrowOnError extends boolean = false>(options: Options<DeploymentsRunData, ThrowOnError>) => RequestResult<DeploymentsRunResponses, unknown, ThrowOnError>;
929
+ /**
930
+ * Get account subdomain
931
+ *
932
+ * Return the account subdomain used in every Worker URL. A default is created on first use.
933
+ */
934
+ export declare const applicationGetSubdomain: <ThrowOnError extends boolean = false>(options?: Options<ApplicationGetSubdomainData, ThrowOnError>) => RequestResult<ApplicationGetSubdomainResponses, ApplicationGetSubdomainErrors, ThrowOnError>;
935
+ /**
936
+ * Change account subdomain
937
+ *
938
+ * Change the account subdomain. Every Worker moves to the new address at once; old addresses stop resolving.
939
+ */
940
+ export declare const applicationPutSubdomain: <ThrowOnError extends boolean = false>(options: Options<ApplicationPutSubdomainData, ThrowOnError>) => RequestResult<ApplicationPutSubdomainResponses, ApplicationPutSubdomainErrors, ThrowOnError>;
941
+ /**
942
+ * List Workers
943
+ *
944
+ * List Workers in your account. Filter by status or by label with label.<key>=<value>.
945
+ */
946
+ export declare const applicationListWorkers: <ThrowOnError extends boolean = false>(options?: Options<ApplicationListWorkersData, ThrowOnError>) => RequestResult<ApplicationListWorkersResponses, ApplicationListWorkersErrors, ThrowOnError>;
947
+ /**
948
+ * Create Worker
949
+ *
950
+ * Create a Worker. It serves nothing until a version is deployed.
951
+ */
952
+ export declare const applicationCreateWorker: <ThrowOnError extends boolean = false>(options: Options<ApplicationCreateWorkerData, ThrowOnError>) => RequestResult<ApplicationCreateWorkerResponses, ApplicationCreateWorkerErrors, ThrowOnError>;
953
+ /**
954
+ * Delete Worker
955
+ *
956
+ * Soft-delete a Worker. Unlike Cloudflare, deletion is reversible: it stops serving at once and can be restored with RestoreWorker for 7 days, after which it is purged.
957
+ */
958
+ export declare const applicationDeleteWorker: <ThrowOnError extends boolean = false>(options: Options<ApplicationDeleteWorkerData, ThrowOnError>) => RequestResult<ApplicationDeleteWorkerResponses, ApplicationDeleteWorkerErrors, ThrowOnError>;
959
+ /**
960
+ * Get Worker
961
+ *
962
+ * Get a Worker. expand returns related objects in the same response.
963
+ */
964
+ export declare const applicationGetWorker: <ThrowOnError extends boolean = false>(options: Options<ApplicationGetWorkerData, ThrowOnError>) => RequestResult<ApplicationGetWorkerResponses, ApplicationGetWorkerErrors, ThrowOnError>;
965
+ /**
966
+ * Update Worker
967
+ *
968
+ * Change name, tags, observability, subdomain or labels. Omitted fields stay unchanged.
969
+ */
970
+ export declare const applicationUpdateWorker: <ThrowOnError extends boolean = false>(options: Options<ApplicationUpdateWorkerData, ThrowOnError>) => RequestResult<ApplicationUpdateWorkerResponses, ApplicationUpdateWorkerErrors, ThrowOnError>;
971
+ /**
972
+ * Restore Worker
973
+ *
974
+ * Bring back a soft-deleted Worker within 7 days of deletion, with its versions and deployments. Cloudflare has no equivalent.
975
+ */
976
+ export declare const applicationRestoreWorker: <ThrowOnError extends boolean = false>(options: Options<ApplicationRestoreWorkerData, ThrowOnError>) => RequestResult<ApplicationRestoreWorkerResponses, ApplicationRestoreWorkerErrors, ThrowOnError>;
977
+ /**
978
+ * List versions
979
+ *
980
+ * List the versions of a Worker, newest first, to pick one to deploy or inspect. Page with next_cursor.
981
+ */
982
+ export declare const applicationListVersions: <ThrowOnError extends boolean = false>(options: Options<ApplicationListVersionsData, ThrowOnError>) => RequestResult<ApplicationListVersionsResponses, ApplicationListVersionsErrors, ThrowOnError>;
983
+ /**
984
+ * Create version
985
+ *
986
+ * Upload code and bindings as a new version; a version serves nothing until deployed. Set deploy true to create the pending deployment in the same call. Rejected binding types return UNSUPPORTED.
987
+ */
988
+ export declare const applicationCreateVersion: <ThrowOnError extends boolean = false>(options: Options<ApplicationCreateVersionData, ThrowOnError>) => RequestResult<ApplicationCreateVersionResponses, ApplicationCreateVersionErrors, ThrowOnError>;
989
+ /**
990
+ * Get version
991
+ *
992
+ * Get one version of a Worker with its modules, bindings and asset settings; secret values are never returned.
993
+ */
994
+ export declare const applicationGetVersion: <ThrowOnError extends boolean = false>(options: Options<ApplicationGetVersionData, ThrowOnError>) => RequestResult<ApplicationGetVersionResponses, ApplicationGetVersionErrors, ThrowOnError>;
995
+ /**
996
+ * List deployments
997
+ *
998
+ * List the deployments of a Worker, newest first; the first active one is serving. Page with next_cursor.
999
+ */
1000
+ export declare const applicationListDeployments: <ThrowOnError extends boolean = false>(options: Options<ApplicationListDeploymentsData, ThrowOnError>) => RequestResult<ApplicationListDeploymentsResponses, ApplicationListDeploymentsErrors, ThrowOnError>;
1001
+ /**
1002
+ * Create deployment
1003
+ *
1004
+ * Deploy one version to serve the Worker. Unlike Cloudflare, a deployment holds exactly one version at 100 percent (no gradual rollout), so strategy must be percentage. Deployment is asynchronous; poll the deployment until praxis.status is active or failed.
1005
+ */
1006
+ export declare const applicationCreateDeployment: <ThrowOnError extends boolean = false>(options: Options<ApplicationCreateDeploymentData, ThrowOnError>) => RequestResult<ApplicationCreateDeploymentResponses, ApplicationCreateDeploymentErrors, ThrowOnError>;
1007
+ /**
1008
+ * Get deployment
1009
+ *
1010
+ * Get one deployment with its status and upload progress; poll this after CreateDeployment until praxis.status is active or failed.
1011
+ */
1012
+ export declare const applicationGetDeployment: <ThrowOnError extends boolean = false>(options: Options<ApplicationGetDeploymentData, ThrowOnError>) => RequestResult<ApplicationGetDeploymentResponses, ApplicationGetDeploymentErrors, ThrowOnError>;
1013
+ /**
1014
+ * List components
1015
+ *
1016
+ * List the databases, namespaces and buckets this Worker owns.
1017
+ */
1018
+ export declare const applicationListComponents: <ThrowOnError extends boolean = false>(options: Options<ApplicationListComponentsData, ThrowOnError>) => RequestResult<ApplicationListComponentsResponses, ApplicationListComponentsErrors, ThrowOnError>;
1019
+ /**
1020
+ * List secrets
1021
+ *
1022
+ * List secret names and sources. Values are never returned.
1023
+ */
1024
+ export declare const applicationListSecrets: <ThrowOnError extends boolean = false>(options: Options<ApplicationListSecretsData, ThrowOnError>) => RequestResult<ApplicationListSecretsResponses, ApplicationListSecretsErrors, ThrowOnError>;
1025
+ /**
1026
+ * Delete secret
1027
+ *
1028
+ * Delete a secret. Unlike Cloudflare, this derives a new version without it and deploys that version.
1029
+ */
1030
+ export declare const applicationDeleteSecret: <ThrowOnError extends boolean = false>(options: Options<ApplicationDeleteSecretData, ThrowOnError>) => RequestResult<ApplicationDeleteSecretResponses, ApplicationDeleteSecretErrors, ThrowOnError>;
1031
+ /**
1032
+ * Put secret
1033
+ *
1034
+ * Create or replace a secret by value or vault reference. Unlike Cloudflare, this derives a new version from the current one and deploys it, so the change is live only once that deployment is active.
1035
+ */
1036
+ export declare const applicationPutSecret: <ThrowOnError extends boolean = false>(options: Options<ApplicationPutSecretData, ThrowOnError>) => RequestResult<ApplicationPutSecretResponses, ApplicationPutSecretErrors, ThrowOnError>;
1037
+ /**
1038
+ * List grants
1039
+ *
1040
+ * List resources this Worker's platform token may access.
1041
+ */
1042
+ export declare const applicationListGrants: <ThrowOnError extends boolean = false>(options: Options<ApplicationListGrantsData, ThrowOnError>) => RequestResult<ApplicationListGrantsResponses, ApplicationListGrantsErrors, ThrowOnError>;
1043
+ /**
1044
+ * Create grant
1045
+ *
1046
+ * Let this Worker's platform token access one of your databases, folders or knowledge bases.
1047
+ */
1048
+ export declare const applicationCreateGrant: <ThrowOnError extends boolean = false>(options: Options<ApplicationCreateGrantData, ThrowOnError>) => RequestResult<ApplicationCreateGrantResponses, ApplicationCreateGrantErrors, ThrowOnError>;
1049
+ /**
1050
+ * Delete grant
1051
+ *
1052
+ * Revoke a grant so this Worker's platform token can no longer access the granted resource. Takes effect for new requests at once.
1053
+ */
1054
+ export declare const applicationDeleteGrant: <ThrowOnError extends boolean = false>(options: Options<ApplicationDeleteGrantData, ThrowOnError>) => RequestResult<ApplicationDeleteGrantResponses, ApplicationDeleteGrantErrors, ThrowOnError>;
1055
+ /**
1056
+ * List events
1057
+ *
1058
+ * List lifecycle events of a Worker in sequence order.
1059
+ */
1060
+ export declare const applicationListEvents: <ThrowOnError extends boolean = false>(options: Options<ApplicationListEventsData, ThrowOnError>) => RequestResult<ApplicationListEventsResponses, ApplicationListEventsErrors, ThrowOnError>;
1061
+ /**
1062
+ * Create asset upload session
1063
+ *
1064
+ * Declare the static file manifest. The answer lists the hashes still missing, grouped into upload batches, and an upload token.
1065
+ */
1066
+ export declare const applicationCreateAssetUploadSession: <ThrowOnError extends boolean = false>(options: Options<ApplicationCreateAssetUploadSessionData, ThrowOnError>) => RequestResult<ApplicationCreateAssetUploadSessionResponses, ApplicationCreateAssetUploadSessionErrors, ThrowOnError>;
1067
+ /**
1068
+ * Upload assets
1069
+ *
1070
+ * Upload one batch: files maps hash to base64 content. The last batch returns the completion token.
1071
+ */
1072
+ export declare const applicationUploadAssets: <ThrowOnError extends boolean = false>(options: Options<ApplicationUploadAssetsData, ThrowOnError>) => RequestResult<ApplicationUploadAssetsResponses, ApplicationUploadAssetsErrors, ThrowOnError>;
1073
+ /**
1074
+ * List actions
1075
+ *
1076
+ * Discover callable Actions and their ns/name references without executing them. Combine each returned namespace and name as ns/name; Action calls use the current revision and do not accept @version or @tag. Filter by name or description; results include seven-day statistics and revision summaries without implementation source. Archived actions are excluded by default.
1077
+ */
1078
+ export declare const automationActionsList: <ThrowOnError extends boolean = false>(options?: Options<AutomationActionsListData, ThrowOnError>) => RequestResult<AutomationActionsListResponses, AutomationActionsListErrors, ThrowOnError>;
1079
+ /**
1080
+ * Create an action
1081
+ *
1082
+ * Create an action definition and its first revision, folding names to lowercase. Duplicate names within the tenant return NAME_TAKEN; the praxis namespace is read-only.
1083
+ */
1084
+ export declare const automationActionsCreate: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsCreateData, ThrowOnError>) => RequestResult<AutomationActionsCreateResponses, AutomationActionsCreateErrors, ThrowOnError>;
1085
+ /**
1086
+ * Get an action
1087
+ *
1088
+ * Read the action and its full current implementation. The response ETag is the current revision ID for conditional updates.
1089
+ */
1090
+ export declare const automationActionsGet: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsGetData, ThrowOnError>) => RequestResult<AutomationActionsGetResponses, AutomationActionsGetErrors, ThrowOnError>;
1091
+ /**
1092
+ * Update an action
1093
+ *
1094
+ * Update after checking compatibility against the current and five recent revisions. Widening inputs and narrowing outputs are compatible, including length, item count, property count, type (integer/number), and multipleOf (the new input factor divides the old one; the reverse holds for outputs). dry_run=true returns only CompatResult and may omit If-Match; a supplied header is still checked, and * matches any existing representation. Normal updates require If-Match and return ActionDef with ETag; previews return no ETag. Omitted optional fields retain their existing values only for description and labels; when constructing a new revision, errors defaults to [], omitted annotations keys to false, timeout_ms to 30000, and message to null. Incompatible normal updates return 422 SCHEMA_INCOMPATIBLE with issues; unchanged contents retain the existing revision.
1095
+ */
1096
+ export declare const automationActionsUpdate: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsUpdateData, ThrowOnError>) => RequestResult<AutomationActionsUpdateResponses, AutomationActionsUpdateErrors, ThrowOnError>;
1097
+ /**
1098
+ * List action revisions
1099
+ *
1100
+ * List revisions newest first with rollback eligibility. Results include the current marker and compatibility issues. Lists omit source by default; only expand=source includes full source, and other values return 400. Detail endpoints retain full source.
1101
+ */
1102
+ export declare const automationActionsRevisions: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsRevisionsData, ThrowOnError>) => RequestResult<AutomationActionsRevisionsResponses, AutomationActionsRevisionsErrors, ThrowOnError>;
1103
+ /**
1104
+ * Get an action revision
1105
+ *
1106
+ * Read a specific revision with its full implementation and rollback compatibility result. A missing revision returns VERSION_NOT_FOUND. Details always return full source.
1107
+ */
1108
+ export declare const automationActionsRevision: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsRevisionData, ThrowOnError>) => RequestResult<AutomationActionsRevisionResponses, AutomationActionsRevisionErrors, ThrowOnError>;
1109
+ /**
1110
+ * Roll back an action
1111
+ *
1112
+ * Create a compatible new revision from historical contents. Compatibility is checked against the current and five recent historical revisions. The current pointer does not revert to the old ID. Optional If-Match accepts the current revision or *; * matches any existing representation.
1113
+ */
1114
+ export declare const automationActionsRollback: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsRollbackData, ThrowOnError>) => RequestResult<AutomationActionsRollbackResponses, AutomationActionsRollbackErrors, ThrowOnError>;
1115
+ /**
1116
+ * List action invocations
1117
+ *
1118
+ * List this action’s invocations, filtering by status, revision, calling definition and time. Results identify the run and call site.
1119
+ */
1120
+ export declare const automationActionsInvocations: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsInvocationsData, ThrowOnError>) => RequestResult<AutomationActionsInvocationsResponses, AutomationActionsInvocationsErrors, ThrowOnError>;
1121
+ /**
1122
+ * List action dependents
1123
+ *
1124
+ * List orchestrations referencing this action. The search covers scripts and workflows in their drafts or latest versions.
1125
+ */
1126
+ export declare const automationActionsDependents: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsDependentsData, ThrowOnError>) => RequestResult<AutomationActionsDependentsResponses, AutomationActionsDependentsErrors, ThrowOnError>;
1127
+ /**
1128
+ * Archive an action
1129
+ *
1130
+ * Archive the action while retaining its name and history, hiding it from the default list. The response includes dependents_count.
1131
+ */
1132
+ export declare const automationActionsArchive: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsArchiveData, ThrowOnError>) => RequestResult<AutomationActionsArchiveResponses, AutomationActionsArchiveErrors, ThrowOnError>;
1133
+ /**
1134
+ * Restore an action
1135
+ *
1136
+ * Restore an archived action to the default list. Its current revision is preserved.
1137
+ */
1138
+ export declare const automationActionsRestore: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsRestoreData, ThrowOnError>) => RequestResult<AutomationActionsRestoreResponses, AutomationActionsRestoreErrors, ThrowOnError>;
1139
+ /**
1140
+ * List scripts
1141
+ *
1142
+ * List visible script summaries, latest versions, tags and seven-day statistics. Archived entries are excluded by default.
1143
+ */
1144
+ export declare const automationScriptsList: <ThrowOnError extends boolean = false>(options?: Options<AutomationScriptsListData, ThrowOnError>) => RequestResult<AutomationScriptsListResponses, AutomationScriptsListErrors, ThrowOnError>;
1145
+ /**
1146
+ * Create a script
1147
+ *
1148
+ * Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is read-only. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: "Hello, " + input.name});`. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.
1149
+ */
1150
+ export declare const automationScriptsCreate: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsCreateData, ThrowOnError>) => RequestResult<AutomationScriptsCreateResponses, AutomationScriptsCreateErrors, ThrowOnError>;
1151
+ /**
1152
+ * Get a script
1153
+ *
1154
+ * Read script details and draft source. The ETag is the draft revision to use in If-Match for updates.
1155
+ */
1156
+ export declare const automationScriptsGet: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsGetData, ThrowOnError>) => RequestResult<AutomationScriptsGetResponses, AutomationScriptsGetErrors, ThrowOnError>;
1157
+ /**
1158
+ * Update a script draft
1159
+ *
1160
+ * Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.
1161
+ */
1162
+ export declare const automationScriptsPatch: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsPatchData, ThrowOnError>) => RequestResult<AutomationScriptsPatchResponses, AutomationScriptsPatchErrors, ThrowOnError>;
1163
+ /**
1164
+ * Archive a script
1165
+ *
1166
+ * Keep the name, versions and draft while archiving. The default list hides it and new target resolution and run requests reject the archived target.
1167
+ */
1168
+ export declare const automationScriptsArchive: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsArchiveData, ThrowOnError>) => RequestResult<AutomationScriptsArchiveResponses, AutomationScriptsArchiveErrors, ThrowOnError>;
1169
+ /**
1170
+ * Restore a script
1171
+ *
1172
+ * Restore an archived definition with its versions and tags. The name is retained.
1173
+ */
1174
+ export declare const automationScriptsRestore: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsRestoreData, ThrowOnError>) => RequestResult<AutomationScriptsRestoreResponses, AutomationScriptsRestoreErrors, ThrowOnError>;
1175
+ /**
1176
+ * List script versions
1177
+ *
1178
+ * Page through immutable schemas and locked dependencies in descending semantic-version order. Lists omit source by default; only expand=source includes full source, and other values return 400. Detail endpoints retain full source.
1179
+ */
1180
+ export declare const automationScriptsVersions: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsVersionsData, ThrowOnError>) => RequestResult<AutomationScriptsVersionsResponses, AutomationScriptsVersionsErrors, ThrowOnError>;
1181
+ /**
1182
+ * Publish a script version
1183
+ *
1184
+ * Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. Publishing removes +build metadata from the version number.
1185
+ */
1186
+ export declare const automationScriptsPublish: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsPublishData, ThrowOnError>) => RequestResult<AutomationScriptsPublishResponses, AutomationScriptsPublishErrors, ThrowOnError>;
1187
+ /**
1188
+ * Get a script version
1189
+ *
1190
+ * Read source, input/output schemas and deprecation details for an exact version. Missing versions return VERSION_NOT_FOUND. Details always return full source. version accepts an exact version or dist-tag; a range returns 400 with a hint to use /resolve.
1191
+ */
1192
+ export declare const automationScriptsVersion: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsVersionData, ThrowOnError>) => RequestResult<AutomationScriptsVersionResponses, AutomationScriptsVersionErrors, ThrowOnError>;
1193
+ /**
1194
+ * Deprecate a script version
1195
+ *
1196
+ * Record a deprecation message; an empty message removes deprecation without changing the version source.
1197
+ */
1198
+ export declare const automationScriptsDeprecate: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsDeprecateData, ThrowOnError>) => RequestResult<AutomationScriptsDeprecateResponses, AutomationScriptsDeprecateErrors, ThrowOnError>;
1199
+ /**
1200
+ * List script tags
1201
+ *
1202
+ * Read the exact version for each distribution tag. Results include the update time and updater.
1203
+ */
1204
+ export declare const automationScriptsDistTags: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsDistTagsData, ThrowOnError>) => RequestResult<AutomationScriptsDistTagsResponses, AutomationScriptsDistTagsErrors, ThrowOnError>;
1205
+ /**
1206
+ * Delete a script tag
1207
+ *
1208
+ * Delete a distribution tag while retaining versions. latest cannot be deleted, versions and ranges are invalid tags, and deleting an absent valid tag is repeatable.
1209
+ */
1210
+ export declare const automationScriptsDeleteDistTag: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsDeleteDistTagData, ThrowOnError>) => RequestResult<AutomationScriptsDeleteDistTagResponses, AutomationScriptsDeleteDistTagErrors, ThrowOnError>;
1211
+ /**
1212
+ * Set a script tag
1213
+ *
1214
+ * Point a distribution tag at an existing exact version; tags cannot be versions or version ranges. Moving latest can roll back a release and synchronizes workflow schedules.
1215
+ */
1216
+ export declare const automationScriptsSetDistTag: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsSetDistTagData, ThrowOnError>) => RequestResult<AutomationScriptsSetDistTagResponses, AutomationScriptsSetDistTagErrors, ThrowOnError>;
1217
+ /**
1218
+ * List workflows
1219
+ *
1220
+ * List visible workflow summaries, latest versions, tags and seven-day statistics. Archived entries are excluded by default.
1221
+ */
1222
+ export declare const automationWorkflowsList: <ThrowOnError extends boolean = false>(options?: Options<AutomationWorkflowsListData, ThrowOnError>) => RequestResult<AutomationWorkflowsListResponses, AutomationWorkflowsListErrors, ThrowOnError>;
1223
+ /**
1224
+ * Create a workflow
1225
+ *
1226
+ * Save a YAML workflow as an editable draft without publishing or starting a run. Choose your own namespace without registering it first; praxis is read-only. To test the draft, send its source and language=yaml to praxis.automation.runs.create. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. run.workflow accepts ns/name@range or {namespace, name, version, input}; run.script uses the same reference shape as a platform extension. Object namespace, name and version are required; version accepts an exact version, dist-tag or range, locked at publication. Object input defaults to {} and supports expressions; string references retain task-level with. run.await defaults to true and returns the child output. With false, the child uses detach and the task immediately returns {run_id}; parent cancellation does not cascade. Inline script.code returns DEFINITION_INVALID with a detail asking you to save a script and reference it first. raise.error retains its type URI, status, title and detail in the run error.
1227
+ */
1228
+ export declare const automationWorkflowsCreate: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsCreateData, ThrowOnError>) => RequestResult<AutomationWorkflowsCreateResponses, AutomationWorkflowsCreateErrors, ThrowOnError>;
1229
+ /**
1230
+ * Get a workflow
1231
+ *
1232
+ * Read workflow details and draft source. The ETag is the draft revision to use in If-Match for updates.
1233
+ */
1234
+ export declare const automationWorkflowsGet: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsGetData, ThrowOnError>) => RequestResult<AutomationWorkflowsGetResponses, AutomationWorkflowsGetErrors, ThrowOnError>;
1235
+ /**
1236
+ * Update a workflow draft
1237
+ *
1238
+ * Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.
1239
+ */
1240
+ export declare const automationWorkflowsPatch: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsPatchData, ThrowOnError>) => RequestResult<AutomationWorkflowsPatchResponses, AutomationWorkflowsPatchErrors, ThrowOnError>;
1241
+ /**
1242
+ * Archive a workflow
1243
+ *
1244
+ * Keep the name, versions and draft while archiving. The default list hides it and new target resolution and run requests reject the archived target.
1245
+ */
1246
+ export declare const automationWorkflowsArchive: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsArchiveData, ThrowOnError>) => RequestResult<AutomationWorkflowsArchiveResponses, AutomationWorkflowsArchiveErrors, ThrowOnError>;
1247
+ /**
1248
+ * Restore a workflow
1249
+ *
1250
+ * Restore an archived definition with its versions and tags. The name is retained.
1251
+ */
1252
+ export declare const automationWorkflowsRestore: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsRestoreData, ThrowOnError>) => RequestResult<AutomationWorkflowsRestoreResponses, AutomationWorkflowsRestoreErrors, ThrowOnError>;
1253
+ /**
1254
+ * List workflow versions
1255
+ *
1256
+ * Page through immutable schemas and locked dependencies in descending semantic-version order. Lists omit source by default; only expand=source includes full source, and other values return 400. Detail endpoints retain full source.
1257
+ */
1258
+ export declare const automationWorkflowsVersions: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsVersionsData, ThrowOnError>) => RequestResult<AutomationWorkflowsVersionsResponses, AutomationWorkflowsVersionsErrors, ThrowOnError>;
1259
+ /**
1260
+ * Publish a workflow version
1261
+ *
1262
+ * Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. String and object run.workflow/run.script references share version resolution and dependency locking. Publishing removes +build metadata from the version number.
1263
+ */
1264
+ export declare const automationWorkflowsPublish: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsPublishData, ThrowOnError>) => RequestResult<AutomationWorkflowsPublishResponses, AutomationWorkflowsPublishErrors, ThrowOnError>;
1265
+ /**
1266
+ * Get a workflow version
1267
+ *
1268
+ * Read source, input/output schemas and deprecation details for an exact version. Missing versions return VERSION_NOT_FOUND. Details always return full source. version accepts an exact version or dist-tag; a range returns 400 with a hint to use /resolve.
1269
+ */
1270
+ export declare const automationWorkflowsVersion: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsVersionData, ThrowOnError>) => RequestResult<AutomationWorkflowsVersionResponses, AutomationWorkflowsVersionErrors, ThrowOnError>;
1271
+ /**
1272
+ * Deprecate a workflow version
1273
+ *
1274
+ * Record a deprecation message; an empty message removes deprecation without changing the version source.
1275
+ */
1276
+ export declare const automationWorkflowsDeprecate: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsDeprecateData, ThrowOnError>) => RequestResult<AutomationWorkflowsDeprecateResponses, AutomationWorkflowsDeprecateErrors, ThrowOnError>;
1277
+ /**
1278
+ * List workflow tags
1279
+ *
1280
+ * Read the exact version for each distribution tag. Results include the update time and updater.
1281
+ */
1282
+ export declare const automationWorkflowsDistTags: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsDistTagsData, ThrowOnError>) => RequestResult<AutomationWorkflowsDistTagsResponses, AutomationWorkflowsDistTagsErrors, ThrowOnError>;
1283
+ /**
1284
+ * Delete a workflow tag
1285
+ *
1286
+ * Delete a distribution tag while retaining versions. latest cannot be deleted, versions and ranges are invalid tags, and deleting an absent valid tag is repeatable.
1287
+ */
1288
+ export declare const automationWorkflowsDeleteDistTag: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsDeleteDistTagData, ThrowOnError>) => RequestResult<AutomationWorkflowsDeleteDistTagResponses, AutomationWorkflowsDeleteDistTagErrors, ThrowOnError>;
1289
+ /**
1290
+ * Set a workflow tag
1291
+ *
1292
+ * Point a distribution tag at an existing exact version; tags cannot be versions or version ranges. Moving latest can roll back a release and synchronizes workflow schedules.
1293
+ */
1294
+ export declare const automationWorkflowsSetDistTag: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsSetDistTagData, ThrowOnError>) => RequestResult<AutomationWorkflowsSetDistTagResponses, AutomationWorkflowsSetDistTagErrors, ThrowOnError>;
1295
+ /**
1296
+ * Validate a definition
1297
+ *
1298
+ * Check source without executing it when you need diagnostics, inferred schemas or references. This is optional before praxis.automation.runs.create, which also validates source before execution. Actions, scripts and workflows are supported; results include validity without saving. Invalid source is reported with valid=false. Script/action output schemas are inferred from return types: Promise unwrapping, Record, intersections and Date. Unknown types yield an empty schema and a warning in warnings. Source diagnostics use /source or /implementation/source with 1-based line/column. For kind=action the same admission checks as action creation apply (no external imports, platform operations only as direct call(praxis/<api>.<op>, input) calls, no agent or automation calls), so source that validates is not rejected at creation.
1299
+ */
1300
+ export declare const automationValidateValidate: <ThrowOnError extends boolean = false>(options: Options<AutomationValidateValidateData, ThrowOnError>) => RequestResult<AutomationValidateValidateResponses, AutomationValidateValidateErrors, ThrowOnError>;
1301
+ /**
1302
+ * Resolve a run target
1303
+ *
1304
+ * Resolve ns/name@tag, an exact version or a version range to a runnable exact version. Omitting @ selects latest; archived targets are rejected and no match returns NO_MATCHING_VERSION.
1305
+ */
1306
+ export declare const automationResolveResolve: <ThrowOnError extends boolean = false>(options: Options<AutomationResolveResolveData, ThrowOnError>) => RequestResult<AutomationResolveResolveResponses, AutomationResolveResolveErrors, ThrowOnError>;
1307
+ /**
1308
+ * Search automation definitions
1309
+ *
1310
+ * Search visible targets and page in ascending name order. Archived targets are excluded by default; optionally select published scripts and workflows.
1311
+ */
1312
+ export declare const automationTargetsTargets: <ThrowOnError extends boolean = false>(options?: Options<AutomationTargetsTargetsData, ThrowOnError>) => RequestResult<AutomationTargetsTargetsResponses, AutomationTargetsTargetsErrors, ThrowOnError>;
1313
+ /**
1314
+ * List runs
1315
+ *
1316
+ * Filter tenant runs and list them newest first. Filters include multiple statuses, target, origin, labels[k] and a creation-time lower bound. q matches a run ID exactly when it starts with run_; otherwise it matches a definition-name prefix. Large input/output values are null in lists with input_truncated/output_truncated true; get run details for full values.
1317
+ */
1318
+ export declare const automationRunsList: <ThrowOnError extends boolean = false>(options?: Options<AutomationRunsListData, ThrowOnError>) => RequestResult<AutomationRunsListResponses, AutomationRunsListErrors, ThrowOnError>;
1319
+ /**
1320
+ * Create a run
1321
+ *
1322
+ * Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. New non-deterministic run IDs contain 78 characters (run_ + 10-character base36 millisecond timestamp + 64-character hexadecimal DO ID), compared with 46 for legacy random IDs. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed. Minimal body: {"source":"export default async () => ({ok: true});","language":"ts","wait":10}.
1323
+ */
1324
+ export declare const automationRunsCreate: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsCreateData, ThrowOnError>) => RequestResult<AutomationRunsCreateResponses, AutomationRunsCreateErrors, ThrowOnError>;
1325
+ /**
1326
+ * Get a run
1327
+ *
1328
+ * Read status, output and error for the id returned by praxis.automation.runs.create; output needs no expand option. A completed status confirms success; faulted and cancelled are terminal without successful completion. Optionally expand calls, tasks, task groups, logs or source in the same request. Pass wait (seconds, 0–60) to hold the request until the run is terminal or the time is up, instead of polling. Expanded pages hold at most 200 entries; use the ledger endpoints and cursors for subsequent pages. Workflow raise errors preserve the full type URI, status, title and detail; only internal platform exceptions are runtime errors.
1329
+ */
1330
+ export declare const automationRunsGet: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsGetData, ThrowOnError>) => RequestResult<AutomationRunsGetResponses, AutomationRunsGetErrors, ThrowOnError>;
1331
+ /**
1332
+ * Cancel a run
1333
+ *
1334
+ * Request run cancellation and return 202. Workflows terminate, while scripts receive an abort request followed by forced termination after a grace period. Terminal runs return 409 RUN_INVALID_STATE; cancellation propagates to attached children, not detached children. Optional reason contains 1–500 characters and is stored as Run.cancel_message; cancel_reason remains user.
1335
+ */
1336
+ export declare const automationRunsCancel: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsCancelData, ThrowOnError>) => RequestResult<AutomationRunsCancelResponses, AutomationRunsCancelErrors, ThrowOnError>;
1337
+ /**
1338
+ * Rerun a run
1339
+ *
1340
+ * Create a new root run from the original exact version or ad hoc source, retaining labels and setting rerun_of. Override input or omit it to reuse the original input; archived targets and run tokens are rejected.
1341
+ */
1342
+ export declare const automationRunsRerun: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsRerunData, ThrowOnError>) => RequestResult<AutomationRunsRerunResponses, AutomationRunsRerunErrors, ThrowOnError>;
1343
+ /**
1344
+ * Suspend a run
1345
+ *
1346
+ * Suspend only a running or waiting workflow. Scripts return OPERATION_NOT_SUPPORTED; other states return RUN_INVALID_STATE.
1347
+ */
1348
+ export declare const automationRunsSuspend: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsSuspendData, ThrowOnError>) => RequestResult<AutomationRunsSuspendResponses, AutomationRunsSuspendErrors, ThrowOnError>;
1349
+ /**
1350
+ * Resume a run
1351
+ *
1352
+ * Resume only a suspended workflow to its prior running or waiting state. It remains suspended if concurrency slots are unavailable; scripts do not support this operation.
1353
+ */
1354
+ export declare const automationRunsResume: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsResumeData, ThrowOnError>) => RequestResult<AutomationRunsResumeResponses, AutomationRunsResumeErrors, ThrowOnError>;
1355
+ /**
1356
+ * List run waits
1357
+ *
1358
+ * List current and historical waits in ledger order. Wait types include event, timer and child.
1359
+ */
1360
+ export declare const automationRunsWaits: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsWaitsData, ThrowOnError>) => RequestResult<AutomationRunsWaitsResponses, AutomationRunsWaitsErrors, ThrowOnError>;
1361
+ /**
1362
+ * List run calls
1363
+ *
1364
+ * Page through the call ledger with execution results. Entries follow ledger order and include targets, argument/result previews, statuses and durations. Script runs read the call ledger; a workflow run records its action calls on its tasks, so this lists the action tasks (skipped ones excluded), matching counters.action_calls.
1365
+ */
1366
+ export declare const automationRunsCalls: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsCallsData, ThrowOnError>) => RequestResult<AutomationRunsCallsResponses, AutomationRunsCallsErrors, ThrowOnError>;
1367
+ /**
1368
+ * List run artifacts
1369
+ *
1370
+ * Read run artifacts and their file references. Entries follow ledger order and include content types, sizes and associated steps.
1371
+ */
1372
+ export declare const automationRunsArtifacts: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsArtifactsData, ThrowOnError>) => RequestResult<AutomationRunsArtifactsResponses, AutomationRunsArtifactsErrors, ThrowOnError>;
1373
+ /**
1374
+ * Complete a run wait
1375
+ *
1376
+ * Complete only an event wait with a payload of at most 32 KiB satisfying its filter; timer and child waits cannot be completed manually. Reusing the same id and payload returns replayed=true; other repeats return WAIT_ALREADY_RESOLVED and expired waits return WAIT_EXPIRED.
1377
+ */
1378
+ export declare const automationRunsCompleteWait: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsCompleteWaitData, ThrowOnError>) => RequestResult<AutomationRunsCompleteWaitResponses, AutomationRunsCompleteWaitErrors, ThrowOnError>;
1379
+ /**
1380
+ * List run tasks
1381
+ *
1382
+ * Page through the task ledger. include=planned adds unexecuted top-level steps; group_by=reference aggregates count, status and duration by task reference.
1383
+ */
1384
+ export declare const automationRunsTasks: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsTasksData, ThrowOnError>) => RequestResult<AutomationRunsTasksResponses, AutomationRunsTasksErrors, ThrowOnError>;
1385
+ /**
1386
+ * Read run events
1387
+ *
1388
+ * Read the CloudEvents ledger or subscribe to live events. Return a CloudEvents ledger page by default; Accept: text/event-stream opens a live stream with ai.praxis.automation.run.status, ai.praxis.automation.run.progress, ai.praxis.automation.call.started, ai.praxis.automation.call.completed, ai.praxis.automation.task.started, ai.praxis.automation.task.completed and ai.praxis.automation.wait.created, ai.praxis.automation.wait.resolved event names. id is the resume cursor and Last-Event-ID takes precedence over cursor; : ping arrives every 20 seconds and event: end closes the stream after a terminal run.
1389
+ */
1390
+ export declare const automationRunsEvents: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsEventsData, ThrowOnError>) => RequestResult<AutomationRunsEventsResponses, AutomationRunsEventsErrors, ThrowOnError>;
1391
+ /**
1392
+ * Read run logs
1393
+ *
1394
+ * Return a log page within the 30-day retention window by default. Accept: text/event-stream opens a live stream using event: log; id is the resume cursor and Last-Event-ID takes precedence over cursor. : ping arrives every 20 seconds and event: end closes the stream after a terminal run.
1395
+ */
1396
+ export declare const automationRunsLogs: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsLogsData, ThrowOnError>) => RequestResult<AutomationRunsLogsResponses, AutomationRunsLogsErrors, ThrowOnError>;
1397
+ /**
1398
+ * Get run source
1399
+ *
1400
+ * Read the source and digest used by the run. Results include the language and SHA-256 digest, for both ad hoc and published-definition runs.
1401
+ */
1402
+ export declare const automationRunsSource: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsSourceData, ThrowOnError>) => RequestResult<AutomationRunsSourceResponses, AutomationRunsSourceErrors, ThrowOnError>;
1403
+ /**
1404
+ * List triggers
1405
+ *
1406
+ * Page through tenant triggers by target, kind and state. ns/name matches all tags or versions of that target; ns/name@spec matches exactly.
1407
+ */
1408
+ export declare const automationTriggersList: <ThrowOnError extends boolean = false>(options?: Options<AutomationTriggersListData, ThrowOnError>) => RequestResult<AutomationTriggersListResponses, AutomationTriggersListErrors, ThrowOnError>;
1409
+ /**
1410
+ * Create a trigger
1411
+ *
1412
+ * Schedule recurring or one-time runs, or start runs from a webhook, for a published script or workflow. For one immediate run without a persistent trigger, use praxis.automation.runs.create. There may be at most 100 enabled triggers per tenant. Targets accept only exact versions or tags; webhook_url is returned only when creating a webhook or rotating its URL, so save it securely.
1413
+ */
1414
+ export declare const automationTriggersCreate: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersCreateData, ThrowOnError>) => RequestResult<AutomationTriggersCreateResponses, AutomationTriggersCreateErrors, ThrowOnError>;
1415
+ /**
1416
+ * Delete a trigger
1417
+ *
1418
+ * Delete the trigger and its firing history, returning 204. Runs already started are unaffected. Definition-managed triggers return 409 TRIGGER_MANAGED; remove schedule from the workflow and publish it again.
1419
+ */
1420
+ export declare const automationTriggersDelete: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersDeleteData, ThrowOnError>) => RequestResult<AutomationTriggersDeleteResponses, AutomationTriggersDeleteErrors, ThrowOnError>;
1421
+ /**
1422
+ * Get a trigger
1423
+ *
1424
+ * Read schedule, state, upcoming times and latest firing. Use the ETag to update; the full webhook URL is not returned again.
1425
+ */
1426
+ export declare const automationTriggersGet: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersGetData, ThrowOnError>) => RequestResult<AutomationTriggersGetResponses, AutomationTriggersGetErrors, ThrowOnError>;
1427
+ /**
1428
+ * Update a trigger
1429
+ *
1430
+ * Update configuration with If-Match matching the current ETag, revalidating target input and schedule. kind is immutable and definition-managed triggers reject updates with TRIGGER_MANAGED.
1431
+ */
1432
+ export declare const automationTriggersPatch: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersPatchData, ThrowOnError>) => RequestResult<AutomationTriggersPatchResponses, AutomationTriggersPatchErrors, ThrowOnError>;
1433
+ /**
1434
+ * Pause a trigger
1435
+ *
1436
+ * Pause new firings without terminating existing runs. Definition-managed triggers can also be paused.
1437
+ */
1438
+ export declare const automationTriggersPause: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersPauseData, ThrowOnError>) => RequestResult<AutomationTriggersPauseResponses, AutomationTriggersPauseErrors, ThrowOnError>;
1439
+ /**
1440
+ * Resume a trigger
1441
+ *
1442
+ * Resume firings and reset consecutive failures. Triggers past their end time or finished one-time schedules remain expired; a full enabled-trigger quota returns TRIGGER_LIMIT.
1443
+ */
1444
+ export declare const automationTriggersResume: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersResumeData, ThrowOnError>) => RequestResult<AutomationTriggersResumeResponses, AutomationTriggersResumeErrors, ThrowOnError>;
1445
+ /**
1446
+ * Fire a trigger now
1447
+ *
1448
+ * Fire once now and return a Firing, subject to current state, catchup window and overlap rules. Run-launch failures are recorded in the firing error.
1449
+ */
1450
+ export declare const automationTriggersFire: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersFireData, ThrowOnError>) => RequestResult<AutomationTriggersFireResponses, AutomationTriggersFireErrors, ThrowOnError>;
1451
+ /**
1452
+ * Rotate a webhook URL
1453
+ *
1454
+ * For webhook triggers only: invalidate the old token immediately and return a new full webhook_url. Later detail reads do not reveal the full URL.
1455
+ */
1456
+ export declare const automationTriggersRotateWebhook: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersRotateWebhookData, ThrowOnError>) => RequestResult<AutomationTriggersRotateWebhookResponses, AutomationTriggersRotateWebhookErrors, ThrowOnError>;
1457
+ /**
1458
+ * List trigger firings
1459
+ *
1460
+ * Read the last 30 days of firings newest first. Results include resolved versions, run IDs and failure details.
1461
+ */
1462
+ export declare const automationTriggersFirings: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersFiringsData, ThrowOnError>) => RequestResult<AutomationTriggersFiringsResponses, AutomationTriggersFiringsErrors, ThrowOnError>;
1463
+ /**
1464
+ * Preview a trigger schedule
1465
+ *
1466
+ * Validate a schedule and preview up to five future firing times. The timezone is validated and a readable description is returned, without creating a trigger or run.
1467
+ */
1468
+ export declare const automationTriggersPreview: <ThrowOnError extends boolean = false>(options: Options<AutomationTriggersPreviewData, ThrowOnError>) => RequestResult<AutomationTriggersPreviewResponses, AutomationTriggersPreviewErrors, ThrowOnError>;
1469
+ /**
1470
+ * Receive a webhook
1471
+ *
1472
+ * No API key is needed: the URL token authenticates requests. Invalid tokens, absent triggers, wrong kinds and inactive time windows return 404; a paused trigger (circuit breaker after 5 consecutive failures, or manual pause) returns 409 TRIGGER_PAUSED whose message gives the reason and whose hint gives the way back, POST /automation/v1/triggers/{id}/resume. Raw bodies are limited to 512 KiB; serialized run input, including raw and parsed copies, must fit within 1 MiB. Exceeding either limit returns 413 synchronously without recording a firing; webhook-id deduplicates for 24 hours. A 202 with outcome=accepted acknowledges receipt; the final outcome is updated later, and repeats return deduped. Invalid JSON yields body=null; other UTF-8 is text and non-UTF-8 is base64. The envelope contains body, raw_body, raw_body_encoding, allowlisted headers, webhook_id and received_at. raw_body preserves exact bytes with utf8 or base64 encoding for caller-side signature verification.
1473
+ */
1474
+ export declare const automationHooksReceive: <ThrowOnError extends boolean = false>(options: Options<AutomationHooksReceiveData, ThrowOnError>) => RequestResult<AutomationHooksReceiveResponses, AutomationHooksReceiveErrors, ThrowOnError>;
1475
+ /**
1476
+ * List databases
1477
+ *
1478
+ * Find databases owned by your tenant and obtain their ids for schema or row operations. Excludes deleting by default. status=active or status=deleting selects that state; invalid values return 400 INVALID_PARAMS.
1479
+ */
1480
+ export declare const databaseListDatabases: <ThrowOnError extends boolean = false>(options?: Options<DatabaseListDatabasesData, ThrowOnError>) => RequestResult<DatabaseListDatabasesResponses, DatabaseListDatabasesErrors, ThrowOnError>;
1481
+ /**
1482
+ * Create database
1483
+ *
1484
+ * Creates an empty database for the caller and returns it with status active (HTTP 201); add tables next with praxis.database.databases.tables.create. name is required and is 1–64 visible characters after trimming. labels are optional string tags (at most 64; each key starts with a lowercase letter and uses up to 63 characters of a-z 0-9 _ -; each value is up to 63 characters of a-z 0-9 _ -) that databaseListDatabases can filter on. If initialization fails the call returns 503 CAPACITY and the half-created database is left with status failed; retry by calling create again, which makes a new database. Unlike Supabase, this creates a SQLite-backed database without a PostgreSQL connection or SQL execution endpoint. Use a Praxis credential; access is scoped to its tenant, not to Supabase Auth users or RLS policies.
1485
+ */
1486
+ export declare const databaseCreateDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseCreateDatabaseData, ThrowOnError>) => RequestResult<DatabaseCreateDatabaseResponses, DatabaseCreateDatabaseErrors, ThrowOnError>;
1487
+ /**
1488
+ * Delete database
1489
+ *
1490
+ * Soft-delete a database when it should stop accepting schema and row operations. Idempotently enters deleting with a seven-day purge_at. GET remains available; child operations return 409 until restored.
1491
+ */
1492
+ export declare const databaseDeleteDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseDeleteDatabaseData, ThrowOnError>) => RequestResult<DatabaseDeleteDatabaseResponses, DatabaseDeleteDatabaseErrors, ThrowOnError>;
1493
+ /**
1494
+ * Get database
1495
+ *
1496
+ * Returns one database by id, including a database in the deleting state (purge_at then shows when it will be permanently removed). Call it before table or row operations to confirm status is active: schema and row calls on a deleting database return 409 DATABASE_INVALID_STATE. size_bytes is refreshed from live storage at most once every five seconds. A purged or unknown id returns 404 DATABASE_NOT_FOUND.
1497
+ */
1498
+ export declare const databaseGetDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseGetDatabaseData, ThrowOnError>) => RequestResult<DatabaseGetDatabaseResponses, DatabaseGetDatabaseErrors, ThrowOnError>;
1499
+ /**
1500
+ * Update database
1501
+ *
1502
+ * Renames an active database and/or replaces its labels; send only the keys you want to change. labels is replaced as a whole, not merged, so include every label you want to keep. A body without name or labels, or with values equal to the current ones, changes nothing and leaves updated_at as is. A database in the deleting state returns 409 DATABASE_INVALID_STATE; restore it first with databaseRestoreDatabase.
1503
+ */
1504
+ export declare const databaseUpdateDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseUpdateDatabaseData, ThrowOnError>) => RequestResult<DatabaseUpdateDatabaseResponses, DatabaseUpdateDatabaseErrors, ThrowOnError>;
1505
+ /**
1506
+ * Restore database
1507
+ *
1508
+ * Recover a soft-deleted database within its seven-day recovery window. Restore before purge_at. An empty body is accepted. Active databases return 409; purged databases return 404.
1509
+ */
1510
+ export declare const databaseRestoreDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseRestoreDatabaseData, ThrowOnError>) => RequestResult<DatabaseRestoreDatabaseResponses, DatabaseRestoreDatabaseErrors, ThrowOnError>;
1511
+ /**
1512
+ * Permanently purge database
1513
+ *
1514
+ * Immediately and irreversibly purges a deleting database. Active databases return 409; absent or already purged databases return 404.
1515
+ */
1516
+ export declare const databasePurgeDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabasePurgeDatabaseData, ThrowOnError>) => RequestResult<DatabasePurgeDatabaseResponses, DatabasePurgeDatabaseErrors, ThrowOnError>;
1517
+ /**
1518
+ * List tables
1519
+ *
1520
+ * Lists every table of an active database with its field definitions. A database holds at most 50 tables, so the single page contains all of them and next_cursor is always null. Use databaseGetTable instead when you also need row_count for one table.
1521
+ */
1522
+ export declare const databaseListTables: <ThrowOnError extends boolean = false>(options: Options<DatabaseListTablesData, ThrowOnError>) => RequestResult<DatabaseListTablesResponses, DatabaseListTablesErrors, ThrowOnError>;
1523
+ /**
1524
+ * Create table
1525
+ *
1526
+ * Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.
1527
+ */
1528
+ export declare const databaseCreateTable: <ThrowOnError extends boolean = false>(options: Options<DatabaseCreateTableData, ThrowOnError>) => RequestResult<DatabaseCreateTableResponses, DatabaseCreateTableErrors, ThrowOnError>;
1529
+ /**
1530
+ * Delete table
1531
+ *
1532
+ * Permanently drops a table with all of its rows; the deletion is immediate and has no recovery window or undo. Refused with 409 REFERENCE_RESTRICT while a link field of another table points at this table, so delete or change those fields first. Returns {deleted: true}. A table name can be reused afterwards.
1533
+ */
1534
+ export declare const databaseDeleteTable: <ThrowOnError extends boolean = false>(options: Options<DatabaseDeleteTableData, ThrowOnError>) => RequestResult<DatabaseDeleteTableResponses, DatabaseDeleteTableErrors, ThrowOnError>;
1535
+ /**
1536
+ * Get table
1537
+ *
1538
+ * Returns one table by id or name with its field definitions, schema_revision and row_count. row_count is only returned by this operation, not by list or create. Use field ids from this response for stable references because field names can be renamed; an unknown table returns 404 TABLE_NOT_FOUND.
1539
+ */
1540
+ export declare const databaseGetTable: <ThrowOnError extends boolean = false>(options: Options<DatabaseGetTableData, ThrowOnError>) => RequestResult<DatabaseGetTableResponses, DatabaseGetTableErrors, ThrowOnError>;
1541
+ /**
1542
+ * Update table
1543
+ *
1544
+ * Renames a table and/or changes its description; send only the keys to change, and send description null to clear it. The new name must follow ^[a-z_][a-z0-9_]{0,62}$ and be unused (409 UNIQUE_VIOLATION); ids are stable, so renaming never rewrites row data. A body with no changes or values equal to the current ones does not bump schema_revision. Fields cannot be changed here; use databaseAddField, databaseUpdateField and databaseDeleteField.
1545
+ */
1546
+ export declare const databaseUpdateTable: <ThrowOnError extends boolean = false>(options: Options<DatabaseUpdateTableData, ThrowOnError>) => RequestResult<DatabaseUpdateTableResponses, DatabaseUpdateTableErrors, ThrowOnError>;
1547
+ /**
1548
+ * Add field
1549
+ *
1550
+ * Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row. Scalar fields are indexed by default, while json and link fields cannot be indexed. Limits: 64 fields and 16 indexed or unique fields per table (400 LIMIT_EXCEEDED). Unlike Supabase, schema evolution uses field definitions rather than ALTER TABLE statements or SQL migrations.
1551
+ */
1552
+ export declare const databaseAddField: <ThrowOnError extends boolean = false>(options: Options<DatabaseAddFieldData, ThrowOnError>) => RequestResult<DatabaseAddFieldResponses, DatabaseAddFieldErrors, ThrowOnError>;
1553
+ /**
1554
+ * Delete field
1555
+ *
1556
+ * Deletes one field definition from a table and returns the updated table; the deletion is immediate and has no recovery window. Look the field up by id or name. The field's index, if any, is dropped with it, and the name can be reused afterwards. Unknown fields return 400 FIELD_NOT_FOUND.
1557
+ */
1558
+ export declare const databaseDeleteField: <ThrowOnError extends boolean = false>(options: Options<DatabaseDeleteFieldData, ThrowOnError>) => RequestResult<DatabaseDeleteFieldResponses, DatabaseDeleteFieldErrors, ThrowOnError>;
1559
+ /**
1560
+ * Update field
1561
+ *
1562
+ * Changes a field's name, description, required flag, indexed flag, default or json options.schema and returns the updated table. The field type, a link field's linked_table_id and the unique flag cannot be changed (400 FIELD_TYPE_IMMUTABLE or INVALID_PARAMS). Setting required to true fails with 400 VALIDATION_FAILED while existing rows hold null for the field. A new json schema constrains only later writes; existing rows are not revalidated. Renaming never rewrites row data, and a request that changes nothing does not bump schema_revision. Unlike Supabase, field types and uniqueness cannot be altered through SQL migrations; use the supported field settings described here.
1563
+ */
1564
+ export declare const databaseUpdateField: <ThrowOnError extends boolean = false>(options: Options<DatabaseUpdateFieldData, ThrowOnError>) => RequestResult<DatabaseUpdateFieldResponses, DatabaseUpdateFieldErrors, ThrowOnError>;
1565
+ /**
1566
+ * List events
1567
+ *
1568
+ * Read lifecycle and schema events, including while the database is deleting. next_cursor is an opaque string cursor (do not do arithmetic on it): pass it as after_seq for asc or before_seq for desc. Supplying both cursors returns 400 INVALID_PARAMS. Unlike Supabase Realtime, this is paged lifecycle and schema history, not a subscription or a row-change feed; row inserts, updates and deletes do not appear here.
1569
+ */
1570
+ export declare const databaseListEvents: <ThrowOnError extends boolean = false>(options: Options<DatabaseListEventsData, ThrowOnError>) => RequestResult<DatabaseListEventsResponses, DatabaseListEventsErrors, ThrowOnError>;
1571
+ /**
1572
+ * Delete rows
1573
+ *
1574
+ * Deletes the rows matched by the filter query parameters (the same filters as databaseSelect); with no filter every row of the table matches. Deletion is immediate and cannot be undone. A row that a link field of another table still references makes the whole call fail with 409 REFERENCE_RESTRICT and nothing is deleted. The default response is 204 with no body; send Prefer: return=representation to get HTTP 200 with the deleted rows.
1575
+ */
1576
+ export declare const databaseDelete: <ThrowOnError extends boolean = false>(options: Options<DatabaseDeleteData, ThrowOnError>) => RequestResult<DatabaseDeleteResponses, DatabaseDeleteErrors, ThrowOnError>;
1577
+ /**
1578
+ * Select rows
1579
+ *
1580
+ * Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property. Praxis SDK/codemode methods return the body only; a page length is not a total unless you know all matches fit in that page.
1581
+ */
1582
+ export declare const databaseSelect: <ThrowOnError extends boolean = false>(options: Options<DatabaseSelectData, ThrowOnError>) => RequestResult<DatabaseSelectResponses, DatabaseSelectErrors, ThrowOnError>;
1583
+ /**
1584
+ * Count rows
1585
+ *
1586
+ * Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is **. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Praxis SDK/codemode methods return only the empty body, not the Content-Range response header; use an HTTP client when you need that header.
1587
+ */
1588
+ export declare const databaseHead: <ThrowOnError extends boolean = false>(options: Options<DatabaseHeadData, ThrowOnError>) => RequestResult<DatabaseHeadResponses, DatabaseHeadErrors, ThrowOnError>;
1589
+ /**
1590
+ * Update rows
1591
+ *
1592
+ * Updates the rows matched by the filter query parameters (the same filters as databaseSelect); with no filter every row of the table matches. The JSON object body lists only the fields to change, other fields keep their values, and id cannot be changed. Values are validated against the field types and the required and unique settings (400 VALIDATION_FAILED, 409 UNIQUE_VIOLATION). The default response is 204 with no body; send Prefer: return=representation to get HTTP 200 with the updated rows. Each changed row's _version increases by one.
1593
+ */
1594
+ export declare const databaseUpdate: <ThrowOnError extends boolean = false>(options: Options<DatabaseUpdateData, ThrowOnError>) => RequestResult<DatabaseUpdateResponses, DatabaseUpdateErrors, ThrowOnError>;
1595
+ /**
1596
+ * Insert rows
1597
+ *
1598
+ * Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.
1599
+ * Rows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.
1600
+ * The default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.
1601
+ */
1602
+ export declare const databaseInsert: <ThrowOnError extends boolean = false>(options: Options<DatabaseInsertData, ThrowOnError>) => RequestResult<DatabaseInsertResponses, DatabaseInsertErrors, ThrowOnError>;
1603
+ /**
1604
+ * List knowledge bases
1605
+ *
1606
+ * Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.
1607
+ */
1608
+ export declare const knowledgeListVectorStores: <ThrowOnError extends boolean = false>(options?: Options<KnowledgeListVectorStoresData, ThrowOnError>) => RequestResult<KnowledgeListVectorStoresResponses, KnowledgeListVectorStoresErrors, ThrowOnError>;
1609
+ /**
1610
+ * Create knowledge base
1611
+ *
1612
+ * Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Unlike OpenAI vector stores, each file is limited to 100000000 bytes and each account to 100 active/nondeleted stores. Minimal body: {"name":"Refund policies"}.
1613
+ */
1614
+ export declare const knowledgeCreateVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeCreateVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeCreateVectorStoreResponses, KnowledgeCreateVectorStoreErrors, ThrowOnError>;
1615
+ /**
1616
+ * Delete knowledge base
1617
+ *
1618
+ * Remove a knowledge base from active use while keeping a recovery window. Unlike OpenAI vector stores, native DELETE returns the store with status=deleting and ISO purge_at, retains it for 7 days and is idempotent on repeat. Retrieve remains 200; object operations return 409. Use restore before purge_at to recover it, or purge to remove it irreversibly.
1619
+ */
1620
+ export declare const knowledgeDeleteVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeDeleteVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeDeleteVectorStoreResponses, KnowledgeDeleteVectorStoreErrors, ThrowOnError>;
1621
+ /**
1622
+ * Retrieve knowledge base
1623
+ *
1624
+ * Retrieves a knowledge base using an id returned by create or list. Add ?expand=files to include the first page of attached files. Soft-deleted stores remain readable with status=deleting until purged.
1625
+ */
1626
+ export declare const knowledgeRetrieveVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeRetrieveVectorStoreResponses, KnowledgeRetrieveVectorStoreErrors, ThrowOnError>;
1627
+ /**
1628
+ * Update knowledge base
1629
+ *
1630
+ * Updates an active knowledge base using its returned id. Omitted fields stay unchanged; metadata replaces the whole map. Example body: {"name":"Refund policies"}.
1631
+ */
1632
+ export declare const knowledgeUpdateVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeUpdateVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeUpdateVectorStoreResponses, KnowledgeUpdateVectorStoreErrors, ThrowOnError>;
1633
+ /**
1634
+ * Search knowledge base
1635
+ *
1636
+ * Search ingested text to answer a question or find supporting passages. Native results contain one chunk each, so file_id can repeat; max_num_results counts chunks (1–50, default 10), while the compatible URL groups results by file. Unlike OpenAI vector stores, next_page is always null even when has_more is true. Only completed attachments are searchable. For keyword-only retrieval set ranking_options.hybrid_search to {"embedding_weight":0,"text_weight":1}; omit rewrite_query or set it to false to avoid query rewriting. Unlike OpenAI, ranker auto does not rerank; only default-2024-11-15 requests reranking. Set praxis.explain=true to inspect scores and use returned content[].chunk_id to retrieve a segment.
1637
+ */
1638
+ export declare const knowledgeSearchVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeSearchVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeSearchVectorStoreResponses, KnowledgeSearchVectorStoreErrors, ThrowOnError>;
1639
+ /**
1640
+ * List files
1641
+ *
1642
+ * Lists attached files and their ingestion status, newest attachment first by default. Use last_id as after to continue; ?filter=failed selects files that can be retried.
1643
+ */
1644
+ export declare const knowledgeListFiles: <ThrowOnError extends boolean = false>(options: Options<KnowledgeListFilesData, ThrowOnError>) => RequestResult<KnowledgeListFilesResponses, KnowledgeListFilesErrors, ThrowOnError>;
1645
+ /**
1646
+ * Add file
1647
+ *
1648
+ * Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. Unlike OpenAI vector stores, the file limit is 100000000 bytes; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.
1649
+ */
1650
+ export declare const knowledgeAttachFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeAttachFileData, ThrowOnError>) => RequestResult<KnowledgeAttachFileResponses, KnowledgeAttachFileErrors, ThrowOnError>;
1651
+ /**
1652
+ * Remove file
1653
+ *
1654
+ * Removes the file from search immediately; does not delete the original File.
1655
+ */
1656
+ export declare const knowledgeRemoveFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRemoveFileData, ThrowOnError>) => RequestResult<KnowledgeRemoveFileResponses, KnowledgeRemoveFileErrors, ThrowOnError>;
1657
+ /**
1658
+ * Retrieve file
1659
+ *
1660
+ * Retrieves an attached file using the id returned by attachment or file listing. Poll this operation until status leaves in_progress to observe the ingestion outcome.
1661
+ */
1662
+ export declare const knowledgeRetrieveFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveFileData, ThrowOnError>) => RequestResult<KnowledgeRetrieveFileResponses, KnowledgeRetrieveFileErrors, ThrowOnError>;
1663
+ /**
1664
+ * Update file attributes
1665
+ *
1666
+ * Replaces search-filter attributes of an existing attachment without reingesting its content. Use an attached file id. Example body: {"attributes":{"category":"refund"}}; null clears the attributes.
1667
+ */
1668
+ export declare const knowledgeUpdateFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeUpdateFileData, ThrowOnError>) => RequestResult<KnowledgeUpdateFileResponses, KnowledgeUpdateFileErrors, ThrowOnError>;
1669
+ /**
1670
+ * Read extracted content
1671
+ *
1672
+ * Extracted text chunks may overlap. Image content can be a generated description rather than verbatim OCR.
1673
+ */
1674
+ export declare const knowledgeRetrieveFileContent: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveFileContentData, ThrowOnError>) => RequestResult<KnowledgeRetrieveFileContentResponses, KnowledgeRetrieveFileContentErrors, ThrowOnError>;
1675
+ /**
1676
+ * Create file batch
1677
+ *
1678
+ * Attaches existing Files as a batch for asynchronous ingestion. Supply exactly one of file_ids or files; files allows per-file settings. Existing attachments are reused. Read the returned batch id to monitor status.
1679
+ */
1680
+ export declare const knowledgeCreateFileBatch: <ThrowOnError extends boolean = false>(options: Options<KnowledgeCreateFileBatchData, ThrowOnError>) => RequestResult<KnowledgeCreateFileBatchResponses, KnowledgeCreateFileBatchErrors, ThrowOnError>;
1681
+ /**
1682
+ * Retrieve file batch
1683
+ *
1684
+ * Retrieves a batch created in this knowledge base, including current status and file counts. Use the batch id returned by batch creation to monitor ingestion.
1685
+ */
1686
+ export declare const knowledgeRetrieveFileBatch: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveFileBatchData, ThrowOnError>) => RequestResult<KnowledgeRetrieveFileBatchResponses, KnowledgeRetrieveFileBatchErrors, ThrowOnError>;
1687
+ /**
1688
+ * Cancel file batch
1689
+ *
1690
+ * Cancels only in-progress batches and pending files. Completed, failed and cancelled batches return unchanged (200, idempotent).
1691
+ */
1692
+ export declare const knowledgeCancelFileBatch: <ThrowOnError extends boolean = false>(options: Options<KnowledgeCancelFileBatchData, ThrowOnError>) => RequestResult<KnowledgeCancelFileBatchResponses, KnowledgeCancelFileBatchErrors, ThrowOnError>;
1693
+ /**
1694
+ * List batch files
1695
+ *
1696
+ * Lists files still attached from the identified batch, newest attachment first by default. Use the batch creation id and ?filter=failed to inspect failures; last_id is the next after cursor.
1697
+ */
1698
+ export declare const knowledgeListBatchFiles: <ThrowOnError extends boolean = false>(options: Options<KnowledgeListBatchFilesData, ThrowOnError>) => RequestResult<KnowledgeListBatchFilesResponses, KnowledgeListBatchFilesErrors, ThrowOnError>;
1699
+ /**
1700
+ * Restore knowledge base
1701
+ *
1702
+ * Restores a deleting store within 7 days. Active stores return 409 VECTOR_STORE_INVALID_STATE; absent stores return 404. Empty body is allowed.
1703
+ */
1704
+ export declare const knowledgeRestoreVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRestoreVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeRestoreVectorStoreResponses, KnowledgeRestoreVectorStoreErrors, ThrowOnError>;
1705
+ /**
1706
+ * Permanently purge knowledge base
1707
+ *
1708
+ * Immediately and irreversibly clears a deleting store using the retention cleanup path. Active stores return 409; absent stores return 404. Empty body is allowed.
1709
+ */
1710
+ export declare const knowledgePurgeVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgePurgeVectorStoreData, ThrowOnError>) => RequestResult<KnowledgePurgeVectorStoreResponses, KnowledgePurgeVectorStoreErrors, ThrowOnError>;
1711
+ /**
1712
+ * Retry failed file
1713
+ *
1714
+ * Retries only failed files; other states return 409 FILE_INVALID_STATE. Retry after failure has not yet been observed in the documented run.
1715
+ */
1716
+ export declare const knowledgeRetryFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetryFileData, ThrowOnError>) => RequestResult<KnowledgeRetryFileResponses, KnowledgeRetryFileErrors, ThrowOnError>;
1717
+ /**
1718
+ * List file segments
1719
+ *
1720
+ * Lists the stored chunks of an attached file, ordered by increasing segment index by default. Use the attachment id and last_id as after to continue; returned chunk ids can be retrieved individually.
1721
+ */
1722
+ export declare const knowledgeListSegments: <ThrowOnError extends boolean = false>(options: Options<KnowledgeListSegmentsData, ThrowOnError>) => RequestResult<KnowledgeListSegmentsResponses, KnowledgeListSegmentsErrors, ThrowOnError>;
1723
+ /**
1724
+ * Retrieve segment
1725
+ *
1726
+ * Retrieves one chunk and its term statistics. Take chunk_id from segment listing or native search content; the chunk must belong to this knowledge base.
1727
+ */
1728
+ export declare const knowledgeRetrieveSegment: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveSegmentData, ThrowOnError>) => RequestResult<KnowledgeRetrieveSegmentResponses, KnowledgeRetrieveSegmentErrors, ThrowOnError>;
1729
+ /**
1730
+ * List events
1731
+ *
1732
+ * Reads events for this knowledge base in increasing sequence order, including while soft-deleted. Pass next_seq as after_seq to continue; null next_seq marks the current end. Example: ?after_seq=0&limit=20.
1733
+ */
1734
+ export declare const knowledgeListEvents: <ThrowOnError extends boolean = false>(options: Options<KnowledgeListEventsData, ThrowOnError>) => RequestResult<KnowledgeListEventsResponses, KnowledgeListEventsErrors, ThrowOnError>;
1735
+ /**
1736
+ * List libraries
1737
+ *
1738
+ * List libraries owned by the caller, newest first. By default, deleting and deleted libraries are excluded; use status=deleting to find libraries awaiting purge. All supplied label pairs must match.
1739
+ */
1740
+ export declare const mediaListLibraries: <ThrowOnError extends boolean = false>(options?: Options<MediaListLibrariesData, ThrowOnError>) => RequestResult<MediaListLibrariesResponses, MediaListLibrariesErrors, ThrowOnError>;
1741
+ /**
1742
+ * Create library
1743
+ *
1744
+ * Create a library owned by the caller with a name, optional labels and understanding settings. Understanding is enabled by default; the returned id is used for subsequent asset operations.
1745
+ */
1746
+ export declare const mediaCreateLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaCreateLibraryData, ThrowOnError>) => RequestResult<MediaCreateLibraryResponses, MediaCreateLibraryErrors, ThrowOnError>;
1747
+ /**
1748
+ * Delete library
1749
+ *
1750
+ * Soft-delete an active library, returning its deleting status and purge_at deadline. Asset operations and delivery become unavailable; the library can be restored before purge_at. Repeated deletion while deleting returns the current library.
1751
+ */
1752
+ export declare const mediaDeleteLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaDeleteLibraryData, ThrowOnError>) => RequestResult<MediaDeleteLibraryResponses, MediaDeleteLibraryErrors, ThrowOnError>;
1753
+ /**
1754
+ * Get library
1755
+ *
1756
+ * Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.
1757
+ */
1758
+ export declare const mediaGetLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaGetLibraryData, ThrowOnError>) => RequestResult<MediaGetLibraryResponses, MediaGetLibraryErrors, ThrowOnError>;
1759
+ /**
1760
+ * Update library
1761
+ *
1762
+ * Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.
1763
+ */
1764
+ export declare const mediaUpdateLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaUpdateLibraryData, ThrowOnError>) => RequestResult<MediaUpdateLibraryResponses, MediaUpdateLibraryErrors, ThrowOnError>;
1765
+ /**
1766
+ * Restore library
1767
+ *
1768
+ * Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.
1769
+ */
1770
+ export declare const mediaRestoreLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaRestoreLibraryData, ThrowOnError>) => RequestResult<MediaRestoreLibraryResponses, MediaRestoreLibraryErrors, ThrowOnError>;
1771
+ /**
1772
+ * Purge library
1773
+ *
1774
+ * Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.
1775
+ */
1776
+ export declare const mediaPurgeLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaPurgeLibraryData, ThrowOnError>) => RequestResult<MediaPurgeLibraryResponses, MediaPurgeLibraryErrors, ThrowOnError>;
1777
+ /**
1778
+ * List assets
1779
+ *
1780
+ * List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.
1781
+ */
1782
+ export declare const mediaListAssets: <ThrowOnError extends boolean = false>(options: Options<MediaListAssetsData, ThrowOnError>) => RequestResult<MediaListAssetsResponses, MediaListAssetsErrors, ThrowOnError>;
1783
+ /**
1784
+ * Upload asset
1785
+ *
1786
+ * Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.
1787
+ */
1788
+ export declare const mediaUploadAsset: <ThrowOnError extends boolean = false>(options: Options<MediaUploadAssetData, ThrowOnError>) => RequestResult<MediaUploadAssetResponses, MediaUploadAssetErrors, ThrowOnError>;
1789
+ /**
1790
+ * Import file
1791
+ *
1792
+ * Copy source content into an active library using upload options and return the full native Asset. The imported asset is independent of the source after copying. Reusing public_id follows overwrite semantics.
1793
+ */
1794
+ export declare const mediaImportAsset: <ThrowOnError extends boolean = false>(options: Options<MediaImportAssetData, ThrowOnError>) => RequestResult<MediaImportAssetResponses, MediaImportAssetErrors, ThrowOnError>;
1795
+ /**
1796
+ * Delete asset
1797
+ *
1798
+ * Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.
1799
+ */
1800
+ export declare const mediaDeleteAsset: <ThrowOnError extends boolean = false>(options: Options<MediaDeleteAssetData, ThrowOnError>) => RequestResult<MediaDeleteAssetResponses, MediaDeleteAssetErrors, ThrowOnError>;
1801
+ /**
1802
+ * Get asset
1803
+ *
1804
+ * Read a non-deleted asset by its asset_id in an active library, including content hashes, processing progress and available previews. Missing or deleted assets return ASSET_NOT_FOUND.
1805
+ */
1806
+ export declare const mediaGetAsset: <ThrowOnError extends boolean = false>(options: Options<MediaGetAssetData, ThrowOnError>) => RequestResult<MediaGetAssetResponses, MediaGetAssetErrors, ThrowOnError>;
1807
+ /**
1808
+ * Update asset
1809
+ *
1810
+ * Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.
1811
+ */
1812
+ export declare const mediaUpdateAsset: <ThrowOnError extends boolean = false>(options: Options<MediaUpdateAssetData, ThrowOnError>) => RequestResult<MediaUpdateAssetResponses, MediaUpdateAssetErrors, ThrowOnError>;
1813
+ /**
1814
+ * Reprocess asset
1815
+ *
1816
+ * Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks; explicit kinds rerun applicable completed tasks. Replaced understandings become superseded, and processing finishes asynchronously.
1817
+ */
1818
+ export declare const mediaReprocessAsset: <ThrowOnError extends boolean = false>(options: Options<MediaReprocessAssetData, ThrowOnError>) => RequestResult<MediaReprocessAssetResponses, MediaReprocessAssetErrors, ThrowOnError>;
1819
+ /**
1820
+ * List understandings
1821
+ *
1822
+ * List an asset’s understanding results in creation order. By default only current, non-superseded results are returned; use include_superseded=true for history or kind to select an output type.
1823
+ */
1824
+ export declare const mediaListUnderstandings: <ThrowOnError extends boolean = false>(options: Options<MediaListUnderstandingsData, ThrowOnError>) => RequestResult<MediaListUnderstandingsResponses, MediaListUnderstandingsErrors, ThrowOnError>;
1825
+ /**
1826
+ * Expression search
1827
+ *
1828
+ * Search active assets using the supported filter-expression syntax, sorting and cursor pagination. Empty expression matches all assets. Tags and context require with_field; inspect the exactness flags before treating counts as complete.
1829
+ */
1830
+ export declare const mediaExpressionSearch: <ThrowOnError extends boolean = false>(options: Options<MediaExpressionSearchData, ThrowOnError>) => RequestResult<MediaExpressionSearchResponses, MediaExpressionSearchErrors, ThrowOnError>;
1831
+ /**
1832
+ * Visual search
1833
+ *
1834
+ * Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.
1835
+ */
1836
+ export declare const mediaVisualSearch: <ThrowOnError extends boolean = false>(options: Options<MediaVisualSearchData, ThrowOnError>) => RequestResult<MediaVisualSearchResponses, MediaVisualSearchErrors, ThrowOnError>;
1837
+ /**
1838
+ * Semantic search
1839
+ *
1840
+ * Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.
1841
+ */
1842
+ export declare const mediaSemanticSearch: <ThrowOnError extends boolean = false>(options: Options<MediaSemanticSearchData, ThrowOnError>) => RequestResult<MediaSemanticSearchResponses, MediaSemanticSearchErrors, ThrowOnError>;
1843
+ /**
1844
+ * Semantic search alias
1845
+ *
1846
+ * Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.
1847
+ */
1848
+ export declare const mediaSearch: <ThrowOnError extends boolean = false>(options: Options<MediaSearchData, ThrowOnError>) => RequestResult<MediaSearchResponses, MediaSearchErrors, ThrowOnError>;
1849
+ /**
1850
+ * List folders
1851
+ *
1852
+ * List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.
1853
+ */
1854
+ export declare const mediaListFolders: <ThrowOnError extends boolean = false>(options: Options<MediaListFoldersData, ThrowOnError>) => RequestResult<MediaListFoldersResponses, MediaListFoldersErrors, ThrowOnError>;
1855
+ /**
1856
+ * Create batch
1857
+ *
1858
+ * Create an asynchronous batch for tagging, untagging, replacing context, moving or deleting assets. Select ids or an expression; selection is frozen at creation. Poll the returned job id for completion and per-item failures.
1859
+ */
1860
+ export declare const mediaCreateBatch: <ThrowOnError extends boolean = false>(options: Options<MediaCreateBatchData, ThrowOnError>) => RequestResult<MediaCreateBatchResponses, MediaCreateBatchErrors, ThrowOnError>;
1861
+ /**
1862
+ * Get batch
1863
+ *
1864
+ * Read a batch job’s status, successful and failed item counts, and a bounded list of failed items. Use the id returned by batch creation; a job outside this library is not found.
1865
+ */
1866
+ export declare const mediaGetBatch: <ThrowOnError extends boolean = false>(options: Options<MediaGetBatchData, ThrowOnError>) => RequestResult<MediaGetBatchResponses, MediaGetBatchErrors, ThrowOnError>;
1867
+ /**
1868
+ * Batch assets alias
1869
+ *
1870
+ * Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.
1871
+ */
1872
+ export declare const mediaBatchAssets: <ThrowOnError extends boolean = false>(options: Options<MediaBatchAssetsData, ThrowOnError>) => RequestResult<MediaBatchAssetsResponses, MediaBatchAssetsErrors, ThrowOnError>;
1873
+ /**
1874
+ * Get job alias
1875
+ *
1876
+ * Alias of batch retrieval. Read the job returned by a batch request, including terminal status, successful and failed counts, and individual failure codes.
1877
+ */
1878
+ export declare const mediaGetJob: <ThrowOnError extends boolean = false>(options: Options<MediaGetJobData, ThrowOnError>) => RequestResult<MediaGetJobResponses, MediaGetJobErrors, ThrowOnError>;
1879
+ /**
1880
+ * List events
1881
+ *
1882
+ * Read library events in sequence order, including while the library is deleting. Page forward with asc and after_seq, or backward with desc and before_seq; never combine the two sequence cursors.
1883
+ */
1884
+ export declare const mediaListEvents: <ThrowOnError extends boolean = false>(options: Options<MediaListEventsData, ThrowOnError>) => RequestResult<MediaListEventsResponses, MediaListEventsErrors, ThrowOnError>;
1885
+ /**
1886
+ * List sandboxes (v2)
1887
+ *
1888
+ * List your running and paused sandboxes with paging and filters. Use it to find a sandboxID before connecting to, pausing or killing a sandbox. Filter by state, template (id or alias), name, metadata (key=value pairs joined with &) and startedAfter; order sorts by start time (default newest first); limit is 1 to 100 (default 100). When more results exist the response carries an x-next-token header; send it back as nextToken for the next page. To read one sandbox use getSandbox.
1889
+ */
1890
+ export declare const getSandboxV1Sandboxes: <ThrowOnError extends boolean = false>(options?: Options<GetSandboxV1SandboxesData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesResponses, GetSandboxV1SandboxesErrors, ThrowOnError>;
1891
+ /**
1892
+ * Create sandbox (v2)
1893
+ *
1894
+ * Start an isolated environment using a templateID from templates.list, then retain sandboxID for lifecycle calls. Unlike E2B, templateID resolves to your ready Environment or a public Base; omit it to use the default base template (`base`), as the E2B SDK does. timeout is seconds from creation and defaults to 300. envVars supplies environment variables and metadata stores your string labels. All system communication is secured; use the returned envdAccessToken for files and commands through the envd data plane, not the management methods. Never print that token.
1895
+ */
1896
+ export declare const postSandboxV1Sandboxes: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesResponses, PostSandboxV1SandboxesErrors, ThrowOnError>;
1897
+ /**
1898
+ * Sandbox metrics
1899
+ *
1900
+ * Read CPU, memory and disk usage over the requested interval; start and end are Unix seconds. Unlike E2B, light sandboxes do not provide metrics; check the returned capabilities before requesting them.
1901
+ */
1902
+ export declare const getSandboxV1SandboxesBySandboxIdMetrics: <ThrowOnError extends boolean = false>(options: Options<GetSandboxV1SandboxesBySandboxIdMetricsData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesBySandboxIdMetricsResponses, GetSandboxV1SandboxesBySandboxIdMetricsErrors, ThrowOnError>;
1903
+ /**
1904
+ * Pause sandbox
1905
+ *
1906
+ * Suspend a running sandbox for later connection; use delete to discard it instead. Unlike E2B, light sandboxes preserve disk rather than memory, and persistent sandboxes can resume on data-plane traffic even when autoResume is false. Inspect paused state with the management retrieve operation to avoid waking the sandbox. Explicitly ephemeral sandboxes cannot pause. memory defaults to true, but only a memory-capable sandbox preserves running processes; memory=false saves disk state and resumes with a cold boot. Success returns 204; connect resumes the saved sandbox.
1907
+ */
1908
+ export declare const postSandboxV1SandboxesBySandboxIdPause: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdPauseData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdPauseResponses, PostSandboxV1SandboxesBySandboxIdPauseErrors, ThrowOnError>;
1909
+ /**
1910
+ * Set sandbox timeout
1911
+ *
1912
+ * Set the timeout for the sandbox. The sandbox will expire x seconds from the time of the request. Calling this method multiple times overwrites the TTL, each time using the current timestamp as the starting point to measure the timeout duration.
1913
+ */
1914
+ export declare const postSandboxV1SandboxesBySandboxIdTimeout: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdTimeoutData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdTimeoutResponses, PostSandboxV1SandboxesBySandboxIdTimeoutErrors, ThrowOnError>;
1915
+ /**
1916
+ * Connect sandbox (v2)
1917
+ *
1918
+ * Reconnect to an existing sandbox and resume it if paused. The optional timeout is seconds from now and defaults to 300; a later existing deadline is preserved. A running sandbox returns 200 and a resumed sandbox returns 201. Read sandboxID, domain and envdAccessToken from the response for subsequent data-plane access; never treat connecting as executing a command.
1919
+ */
1920
+ export declare const postSandboxV1SandboxesBySandboxIdConnect: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdConnectData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdConnectResponses, PostSandboxV1SandboxesBySandboxIdConnectErrors, ThrowOnError>;
1921
+ /**
1922
+ * List templates (v2)
1923
+ *
1924
+ * Choose a templateID before creating a sandbox. Unlike E2B, this catalog lists your ready Environments and public Bases; use a returned ID or alias; `base` is the default template that create uses when templateID is omitted. Page through results using nextToken.
1925
+ */
1926
+ export declare const getSandboxV1Templates: <ThrowOnError extends boolean = false>(options?: Options<GetSandboxV1TemplatesData, ThrowOnError>) => RequestResult<GetSandboxV1TemplatesResponses, GetSandboxV1TemplatesErrors, ThrowOnError>;
1927
+ /**
1928
+ * List team volumes
1929
+ *
1930
+ * List the volumes of your team. Use it to find a volumeID before reading or deleting a volume, or to attach a volume to a sandbox by name when you create it.
1931
+ */
1932
+ export declare const getSandboxV1Volumes: <ThrowOnError extends boolean = false>(options?: Options<GetSandboxV1VolumesData, ThrowOnError>) => RequestResult<GetSandboxV1VolumesResponses, GetSandboxV1VolumesErrors, ThrowOnError>;
1933
+ /**
1934
+ * Create team volume
1935
+ *
1936
+ * Create a team volume: persistent storage that can be mounted into sandboxes and outlives them. Send the volume name; the response returns the volume id and name. Use getVolume to read it back and deleteVolume to remove it.
1937
+ */
1938
+ export declare const postSandboxV1Volumes: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1VolumesData, ThrowOnError>) => RequestResult<PostSandboxV1VolumesResponses, PostSandboxV1VolumesErrors, ThrowOnError>;
1939
+ /**
1940
+ * Delete team volume
1941
+ *
1942
+ * Delete a team volume and its data permanently. Use it only when no sandbox needs the volume any more; the data cannot be recovered. Success answers 204; an unknown id answers 404.
1943
+ */
1944
+ export declare const deleteSandboxV1VolumesByVolumeId: <ThrowOnError extends boolean = false>(options: Options<DeleteSandboxV1VolumesByVolumeIdData, ThrowOnError>) => RequestResult<DeleteSandboxV1VolumesByVolumeIdResponses, DeleteSandboxV1VolumesByVolumeIdErrors, ThrowOnError>;
1945
+ /**
1946
+ * Team volume
1947
+ *
1948
+ * Read one team volume by id. Use it to confirm a volume exists and to read its name before mounting it in a sandbox. An unknown id answers 404.
1949
+ */
1950
+ export declare const getSandboxV1VolumesByVolumeId: <ThrowOnError extends boolean = false>(options: Options<GetSandboxV1VolumesByVolumeIdData, ThrowOnError>) => RequestResult<GetSandboxV1VolumesByVolumeIdResponses, GetSandboxV1VolumesByVolumeIdErrors, ThrowOnError>;
1951
+ /**
1952
+ * Fork sandbox
1953
+ *
1954
+ * Fork the sandbox: checkpoint the running sandbox in place (it is briefly paused, snapshotted with its full memory state, and resumed on its node, keeping its ID and expiration untouched) and create count new sandboxes from that snapshot. Returns one result per requested fork, each carrying either the created sandbox or the error that prevented it from starting. A non-201 status means the request failed before any fork was attempted.
1955
+ */
1956
+ export declare const postSandboxV1SandboxesBySandboxIdFork: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdForkData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdForkResponses, PostSandboxV1SandboxesBySandboxIdForkErrors, ThrowOnError>;
1957
+ /**
1958
+ * Create snapshot
1959
+ *
1960
+ * Create a persistent snapshot from the sandbox's current state. Snapshots can be used to create new sandboxes and persist beyond the original sandbox's lifetime.
1961
+ */
1962
+ export declare const postSandboxV1SandboxesBySandboxIdSnapshots: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdSnapshotsData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdSnapshotsResponses, PostSandboxV1SandboxesBySandboxIdSnapshotsErrors, ThrowOnError>;
1963
+ /**
1964
+ * List snapshots
1965
+ *
1966
+ * List the snapshots you created, one cursor page at a time. Use it to find a snapshot id before you create a sandbox from it or delete it. Filter by sandboxID (the source sandbox) or by name or snapshot id, optionally tag-qualified; limit is 1 to 100 (default 100). When more results exist send the cursor from the response back as nextToken.
1967
+ */
1968
+ export declare const getSandboxV1Snapshots: <ThrowOnError extends boolean = false>(options?: Options<GetSandboxV1SnapshotsData, ThrowOnError>) => RequestResult<GetSandboxV1SnapshotsResponses, GetSandboxV1SnapshotsErrors, ThrowOnError>;
1969
+ /**
1970
+ * Delete template
1971
+ *
1972
+ * Delete one of your snapshots. Sandboxes already created from it keep running; no new sandbox can be created from it afterwards. Success answers 204. A snapshot that does not exist or belongs to someone else answers 404.
1973
+ */
1974
+ export declare const deleteSandboxV1SnapshotsBySnapshotId: <ThrowOnError extends boolean = false>(options: Options<DeleteSandboxV1SnapshotsBySnapshotIdData, ThrowOnError>) => RequestResult<DeleteSandboxV1SnapshotsBySnapshotIdResponses, DeleteSandboxV1SnapshotsBySnapshotIdErrors, ThrowOnError>;
1975
+ /**
1976
+ * Update sandbox network
1977
+ *
1978
+ * Update the network configuration for a running sandbox. Replaces the current egress rules with the provided configuration. Omitting field clears it.
1979
+ */
1980
+ export declare const putSandboxV1SandboxesBySandboxIdNetwork: <ThrowOnError extends boolean = false>(options: Options<PutSandboxV1SandboxesBySandboxIdNetworkData, ThrowOnError>) => RequestResult<PutSandboxV1SandboxesBySandboxIdNetworkResponses, PutSandboxV1SandboxesBySandboxIdNetworkErrors, ThrowOnError>;
1981
+ /**
1982
+ * Sandbox logs (v2)
1983
+ *
1984
+ * Read the log lines of a sandbox. Use it to debug what ran inside a sandbox. cursor is a start timestamp in milliseconds, direction chooses forward or backward from it, level sets the lowest level to return, search is a case-sensitive substring filter (at most 256 characters) and limit caps the count (at most 1000, default 1000). To continue, pass the timestamp of the last entry as the next cursor.
1985
+ */
1986
+ export declare const getSandboxV1SandboxesBySandboxIdLogs: <ThrowOnError extends boolean = false>(options: Options<GetSandboxV1SandboxesBySandboxIdLogsData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesBySandboxIdLogsResponses, GetSandboxV1SandboxesBySandboxIdLogsErrors, ThrowOnError>;
1987
+ /**
1988
+ * Search for data based on a query
1989
+ *
1990
+ * Search the web and return ranked results with extracted content. Use it to answer questions with current information; to read the full text of known URLs use searchExtract, to walk a site use searchCrawl and to list a site's URLs use searchMap. query is required. topic chooses general, news or finance; time_range limits results to the last day, week, month or year; country boosts results from one country (topic general only). Each result carries title, url, content and a relevance score, and the response can include a generated answer, images and follow-up questions when requested.
1991
+ */
1992
+ export declare const searchSearch: <ThrowOnError extends boolean = false>(options: Options<SearchSearchData, ThrowOnError>) => RequestResult<SearchSearchResponses, SearchSearchErrors, ThrowOnError>;
1993
+ /**
1994
+ * Retrieve raw web content from specified URLs
1995
+ *
1996
+ * Extract content from one URL or batch up to 20 URLs in one request. Successful URLs appear in results; per-URL failures appear in failed_results. Check both arrays even when the response is HTTP 200. Request options apply to every URL in the batch.
1997
+ */
1998
+ export declare const searchExtract: <ThrowOnError extends boolean = false>(options: Options<SearchExtractData, ThrowOnError>) => RequestResult<SearchExtractResponses, SearchExtractErrors, ThrowOnError>;
1999
+ /**
2000
+ * Initiate a web crawl from a base URL
2001
+ *
2002
+ * Tavily Crawl is a graph-based website traversal tool that can explore hundreds of paths in parallel with built-in extraction and intelligent discovery.
2003
+ */
2004
+ export declare const searchCrawl: <ThrowOnError extends boolean = false>(options: Options<SearchCrawlData, ThrowOnError>) => RequestResult<SearchCrawlResponses, SearchCrawlErrors, ThrowOnError>;
2005
+ /**
2006
+ * Initiate a web mapping from a base URL
2007
+ *
2008
+ * Tavily Map traverses websites like a graph and can explore hundreds of paths in parallel with intelligent discovery to generate comprehensive site maps.
2009
+ */
2010
+ export declare const searchMap: <ThrowOnError extends boolean = false>(options: Options<SearchMapData, ThrowOnError>) => RequestResult<SearchMapResponses, SearchMapErrors, ThrowOnError>;
2011
+ /**
2012
+ * List vaults
2013
+ *
2014
+ * List vaults belonging to your account, newest first. Archived vaults are excluded unless include_archived is true; use next_cursor to request another page.
2015
+ */
2016
+ export declare const vaultListVaults: <ThrowOnError extends boolean = false>(options?: Options<VaultListVaultsData, ThrowOnError>) => RequestResult<VaultListVaultsResponses, VaultListVaultsErrors, ThrowOnError>;
2017
+ /**
2018
+ * Create vault
2019
+ *
2020
+ * Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations. Unlike Anthropic, Agent sessions do not accept nonempty vault_ids; storing a credential or adding its ID to metadata does not enable vault-backed MCP authentication. Application vault references are also unavailable; praxis_vault_ref version bindings and secret writes with a vault source return 501, so creating a vault does not yet enable either consumer.
2021
+ */
2022
+ export declare const vaultCreateVault: <ThrowOnError extends boolean = false>(options: Options<VaultCreateVaultData, ThrowOnError>) => RequestResult<VaultCreateVaultResponses, VaultCreateVaultErrors, ThrowOnError>;
2023
+ /**
2024
+ * Check vaults
2025
+ *
2026
+ * Check the availability of each supplied vault ID in request order. Missing, malformed and other accounts' IDs all return not_found; duplicate IDs are preserved.
2027
+ */
2028
+ export declare const vaultCheckVaults: <ThrowOnError extends boolean = false>(options: Options<VaultCheckVaultsData, ThrowOnError>) => RequestResult<VaultCheckVaultsResponses, VaultCheckVaultsErrors, ThrowOnError>;
2029
+ /**
2030
+ * Delete vault
2031
+ *
2032
+ * Permanently delete a vault, its secrets, authorizations and previous audit events. Only a vault deletion event remains; the deleted vault can no longer be retrieved.
2033
+ */
2034
+ export declare const vaultDeleteVault: <ThrowOnError extends boolean = false>(options: Options<VaultDeleteVaultData, ThrowOnError>) => RequestResult<VaultDeleteVaultResponses, VaultDeleteVaultErrors, ThrowOnError>;
2035
+ /**
2036
+ * Get vault
2037
+ *
2038
+ * Retrieve a vault belonging to your account, including archived vaults and secret counts. Missing or other accounts' vaults return VAULT_NOT_FOUND.
2039
+ */
2040
+ export declare const vaultGetVault: <ThrowOnError extends boolean = false>(options: Options<VaultGetVaultData, ThrowOnError>) => RequestResult<VaultGetVaultResponses, VaultGetVaultErrors, ThrowOnError>;
2041
+ /**
2042
+ * Update vault
2043
+ *
2044
+ * Update an active vault's display name or patch its metadata. Omitted fields are preserved; archived vaults cannot be updated.
2045
+ */
2046
+ export declare const vaultUpdateVault: <ThrowOnError extends boolean = false>(options: Options<VaultUpdateVaultData, ThrowOnError>) => RequestResult<VaultUpdateVaultResponses, VaultUpdateVaultErrors, ThrowOnError>;
2047
+ /**
2048
+ * Archive vault
2049
+ *
2050
+ * Archive a vault and all its remaining secrets, erasing their values while retaining metadata and audit history. An already archived vault is returned unchanged.
2051
+ */
2052
+ export declare const vaultArchiveVault: <ThrowOnError extends boolean = false>(options: Options<VaultArchiveVaultData, ThrowOnError>) => RequestResult<VaultArchiveVaultResponses, VaultArchiveVaultErrors, ThrowOnError>;
2053
+ /**
2054
+ * List events
2055
+ *
2056
+ * List a vault's audit events, newest first, without secret values. Filter by secret ID or name; a name includes archived and deleted secrets that carried it. An unknown secret returns an empty page.
2057
+ */
2058
+ export declare const vaultListEvents: <ThrowOnError extends boolean = false>(options: Options<VaultListEventsData, ThrowOnError>) => RequestResult<VaultListEventsResponses, VaultListEventsErrors, ThrowOnError>;
2059
+ /**
2060
+ * List secrets
2061
+ *
2062
+ * List secret metadata in a vault, newest first, without returning values. Archived secrets are excluded unless include_archived is true.
2063
+ */
2064
+ export declare const vaultListSecrets: <ThrowOnError extends boolean = false>(options: Options<VaultListSecretsData, ThrowOnError>) => RequestResult<VaultListSecretsResponses, VaultListSecretsErrors, ThrowOnError>;
2065
+ /**
2066
+ * Create secret
2067
+ *
2068
+ * Store a manually supplied token in an active vault for use on requests to its allowed_hosts. Unlike Anthropic credentials, this native operation takes name, value and allowed_hosts directly and creates only static secrets; use praxis.vault.authorizations.create for OAuth. Its name must be unused by any non-archived secret in that vault; the response contains metadata but never the supplied value. Application praxis_vault_ref bindings declare vault_id and secret (the secret name), but currently return 501; do not copy the value into a plain-text binding or metadata as a substitute.
2069
+ */
2070
+ export declare const vaultCreateSecret: <ThrowOnError extends boolean = false>(options: Options<VaultCreateSecretData, ThrowOnError>) => RequestResult<VaultCreateSecretResponses, VaultCreateSecretErrors, ThrowOnError>;
2071
+ /**
2072
+ * Import secrets
2073
+ *
2074
+ * Import lines or dotenv text into an active vault, reporting success or failure for each entry. Existing names have their values replaced; their hosts change only when that line supplies allowed_hosts. Shared hosts apply only to newly created secrets.
2075
+ */
2076
+ export declare const vaultImportSecrets: <ThrowOnError extends boolean = false>(options: Options<VaultImportSecretsData, ThrowOnError>) => RequestResult<VaultImportSecretsResponses, VaultImportSecretsErrors, ThrowOnError>;
2077
+ /**
2078
+ * Delete secret
2079
+ *
2080
+ * Permanently delete a secret and its previous audit events. A deletion event retaining the secret ID and name remains, and other secrets are unchanged.
2081
+ */
2082
+ export declare const vaultDeleteSecret: <ThrowOnError extends boolean = false>(options: Options<VaultDeleteSecretData, ThrowOnError>) => RequestResult<VaultDeleteSecretResponses, VaultDeleteSecretErrors, ThrowOnError>;
2083
+ /**
2084
+ * Get secret
2085
+ *
2086
+ * Inspect a secret's kind, allowed_hosts, status and version without reading its value. Unlike Anthropic credential lookup by ID, this native operation accepts either the name or the vsec_ ID returned by secret creation or listing. A name selects a non-archived secret; use the secret ID to retrieve an archived secret.
2087
+ */
2088
+ export declare const vaultGetSecret: <ThrowOnError extends boolean = false>(options: Options<VaultGetSecretData, ThrowOnError>) => RequestResult<VaultGetSecretResponses, VaultGetSecretErrors, ThrowOnError>;
2089
+ /**
2090
+ * Update secret
2091
+ *
2092
+ * Rotate a non-archived secret in an active vault by supplying value, or patch its hosts, description or metadata. Unlike Anthropic credential updates, this native operation accepts the replacement value directly, without an auth object. Each supplied value increments version, even if unchanged, and can recover an OAuth secret from refresh_failed; the secret ID, name and kind stay unchanged. Omit value for a metadata-only edit; existing references do not need a new secret ID or name.
2093
+ */
2094
+ export declare const vaultUpdateSecret: <ThrowOnError extends boolean = false>(options: Options<VaultUpdateSecretData, ThrowOnError>) => RequestResult<VaultUpdateSecretResponses, VaultUpdateSecretErrors, ThrowOnError>;
2095
+ /**
2096
+ * Archive secret
2097
+ *
2098
+ * Archive a secret, erase its value and release its name for reuse. Metadata and audit history remain; use its ID for subsequent reads or repeated archive requests.
2099
+ */
2100
+ export declare const vaultArchiveSecret: <ThrowOnError extends boolean = false>(options: Options<VaultArchiveSecretData, ThrowOnError>) => RequestResult<VaultArchiveSecretResponses, VaultArchiveSecretErrors, ThrowOnError>;
2101
+ /**
2102
+ * Validate secret
2103
+ *
2104
+ * Probe an OAuth secret's resource with its access token, attempting refresh first if the token has expired. Return the validation verdict and sanitized HTTP summaries; static secrets are unsupported.
2105
+ */
2106
+ export declare const vaultValidateSecret: <ThrowOnError extends boolean = false>(options: Options<VaultValidateSecretData, ThrowOnError>) => RequestResult<VaultValidateSecretResponses, VaultValidateSecretErrors, ThrowOnError>;
2107
+ /**
2108
+ * Refresh secret
2109
+ *
2110
+ * Request an OAuth secret refresh and return its current metadata without token values. Refresh may be skipped if already in progress, unavailable or in refresh_failed; inspect the returned status and oauth fields.
2111
+ */
2112
+ export declare const vaultRefreshSecret: <ThrowOnError extends boolean = false>(options: Options<VaultRefreshSecretData, ThrowOnError>) => RequestResult<VaultRefreshSecretResponses, VaultRefreshSecretErrors, ThrowOnError>;
2113
+ /**
2114
+ * List templates
2115
+ *
2116
+ * List templates for manually supplied static secrets and OAuth authorizations. Templates provide suggested names and allowed hosts; they are not stored secrets.
2117
+ */
2118
+ export declare const vaultListTemplates: <ThrowOnError extends boolean = false>(options?: Options<VaultListTemplatesData, ThrowOnError>) => RequestResult<VaultListTemplatesResponses, VaultListTemplatesErrors, ThrowOnError>;
2119
+ /**
2120
+ * Create authorization
2121
+ *
2122
+ * Connect an OAuth service to an active vault using either an OAuth template or a resource URL. Unlike Anthropic mcp_oauth credential creation, this flow obtains tokens through user consent rather than accepting an auth token bundle; compatible mcp_oauth creation and updates return 501. Open connect_url, then poll praxis.vault.authorizations.retrieve until completed, failed or expired; only completed supplies the resulting secret_id. This stores a credential but does not enable vault-backed MCP authentication in Agent sessions.
2123
+ */
2124
+ export declare const vaultCreateAuthorization: <ThrowOnError extends boolean = false>(options: Options<VaultCreateAuthorizationData, ThrowOnError>) => RequestResult<VaultCreateAuthorizationResponses, VaultCreateAuthorizationErrors, ThrowOnError>;
2125
+ /**
2126
+ * Get authorization
2127
+ *
2128
+ * Retrieve an authorization belonging to your account, including its current status and resulting secret_id. An unfinished authorization past expires_at is reported as expired.
2129
+ */
2130
+ export declare const vaultGetAuthorization: <ThrowOnError extends boolean = false>(options: Options<VaultGetAuthorizationData, ThrowOnError>) => RequestResult<VaultGetAuthorizationResponses, VaultGetAuthorizationErrors, ThrowOnError>;
2131
+ /**
2132
+ * Get return URLs
2133
+ *
2134
+ * Read your account's allowlist of OAuth return URLs. The list is empty until configured, and authorization return_url values must match an entry exactly.
2135
+ */
2136
+ export declare const vaultGetReturnUrls: <ThrowOnError extends boolean = false>(options?: Options<VaultGetReturnUrlsData, ThrowOnError>) => RequestResult<VaultGetReturnUrlsResponses, VaultGetReturnUrlsErrors, ThrowOnError>;
2137
+ /**
2138
+ * Set return URLs
2139
+ *
2140
+ * Replace your account's complete allowlist of OAuth return URLs. Entries are deduplicated after validation; an empty array clears the allowlist.
2141
+ */
2142
+ export declare const vaultSetReturnUrls: <ThrowOnError extends boolean = false>(options: Options<VaultSetReturnUrlsData, ThrowOnError>) => RequestResult<VaultSetReturnUrlsResponses, VaultSetReturnUrlsErrors, ThrowOnError>;
2143
+ /**
2144
+ * Authorization callback
2145
+ *
2146
+ * Receive the authorization server's OAuth callback with single-use state and an authorization code or error. Completion creates or updates an OAuth secret; the browser is redirected to return_url when provided, otherwise shown a result page.
2147
+ */
2148
+ export declare const vaultAuthorizationCallback: <ThrowOnError extends boolean = false>(options?: Options<VaultAuthorizationCallbackData, ThrowOnError>) => RequestResult<VaultAuthorizationCallbackResponses, unknown, ThrowOnError>;
2149
+ /**
2150
+ * OAuth client metadata
2151
+ *
2152
+ * Return the public OAuth client metadata used by authorization servers that support CIMD. The document declares the Praxis client identity and callback URL; no API key is required.
2153
+ */
2154
+ export declare const vaultOAuthClientMetadata: <ThrowOnError extends boolean = false>(options?: Options<VaultOAuthClientMetadataData, ThrowOnError>) => RequestResult<VaultOAuthClientMetadataResponses, unknown, ThrowOnError>;
2155
+ /**
2156
+ * Connect page
2157
+ *
2158
+ * Display the user consent page for a connect_url token without requiring an API key. The page shows the requester, resource host and requested scopes before the user continues or denies.
2159
+ */
2160
+ export declare const vaultConnectPage: <ThrowOnError extends boolean = false>(options: Options<VaultConnectPageData, ThrowOnError>) => RequestResult<VaultConnectPageResponses, VaultConnectPageErrors, ThrowOnError>;
2161
+ /**
2162
+ * Continue authorization
2163
+ *
2164
+ * Consume a pending authorization's one-time connect token and redirect the browser to the authorization server. Expired or already used links cannot start another authorization flow.
2165
+ */
2166
+ export declare const vaultConnectContinue: <ThrowOnError extends boolean = false>(options: Options<VaultConnectContinueData, ThrowOnError>) => RequestResult<unknown, unknown, ThrowOnError>;
2167
+ /**
2168
+ * Deny authorization
2169
+ *
2170
+ * Consume a pending authorization's one-time connect token and mark it failed with access_denied. Redirect to the configured return URL, or display a result page when none was supplied.
2171
+ */
2172
+ export declare const vaultConnectDeny: <ThrowOnError extends boolean = false>(options: Options<VaultConnectDenyData, ThrowOnError>) => RequestResult<VaultConnectDenyResponses, unknown, ThrowOnError>;