browser-use-sdk 2.0.4 → 2.0.6
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.
- package/dist/cjs/BaseClient.d.ts +30 -0
- package/dist/cjs/BaseClient.js +3 -0
- package/dist/cjs/Client.d.ts +14 -28
- package/dist/cjs/Client.js +26 -18
- package/dist/cjs/api/errors/BadRequestError.d.ts +1 -4
- package/dist/cjs/api/errors/BadRequestError.js +1 -3
- package/dist/cjs/api/errors/ForbiddenError.d.ts +6 -0
- package/dist/cjs/api/errors/ForbiddenError.js +50 -0
- package/dist/cjs/api/errors/InternalServerError.d.ts +1 -4
- package/dist/cjs/api/errors/InternalServerError.js +1 -3
- package/dist/cjs/api/errors/NotFoundError.d.ts +1 -4
- package/dist/cjs/api/errors/NotFoundError.js +1 -3
- package/dist/cjs/api/errors/PaymentRequiredError.d.ts +2 -5
- package/dist/cjs/api/errors/PaymentRequiredError.js +1 -3
- package/dist/cjs/api/errors/TooManyRequestsError.d.ts +2 -5
- package/dist/cjs/api/errors/TooManyRequestsError.js +1 -3
- package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +1 -4
- package/dist/cjs/api/errors/UnprocessableEntityError.js +1 -3
- package/dist/cjs/api/errors/index.d.ts +4 -3
- package/dist/cjs/api/errors/index.js +4 -3
- package/dist/cjs/api/index.d.ts +1 -1
- package/dist/cjs/api/index.js +1 -1
- package/dist/cjs/api/resources/billing/client/Client.d.ts +27 -0
- package/dist/cjs/api/resources/{accounts → billing}/client/Client.js +23 -20
- package/dist/cjs/api/resources/browsers/client/Client.d.ts +90 -0
- package/dist/cjs/api/resources/browsers/client/Client.js +374 -0
- package/dist/cjs/api/resources/browsers/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/browsers/client/index.js +17 -0
- package/dist/cjs/api/resources/browsers/client/requests/CreateBrowserSessionRequest.d.ts +13 -0
- package/dist/cjs/api/resources/browsers/client/requests/CreateBrowserSessionRequest.js +3 -0
- package/dist/cjs/api/resources/browsers/client/requests/GetBrowserSessionBrowsersSessionIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/browsers/client/requests/GetBrowserSessionBrowsersSessionIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/browsers/client/requests/ListBrowserSessionsBrowsersGetRequest.d.ts +10 -0
- package/dist/cjs/api/resources/browsers/client/requests/ListBrowserSessionsBrowsersGetRequest.js +3 -0
- package/dist/cjs/api/resources/browsers/client/requests/UpdateBrowserSessionRequest.d.ts +9 -0
- package/dist/cjs/api/resources/browsers/client/requests/UpdateBrowserSessionRequest.js +3 -0
- package/dist/cjs/api/resources/browsers/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/browsers/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/browsers/index.d.ts +1 -0
- package/dist/cjs/api/resources/browsers/index.js +17 -0
- package/dist/cjs/api/resources/files/client/Client.d.ts +44 -38
- package/dist/cjs/api/resources/files/client/Client.js +125 -33
- package/dist/cjs/api/resources/files/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/files/client/requests/AgentSessionUploadFilePresignedUrlFilesSessionsSessionIdPresignedUrlPostRequest.d.ts +16 -0
- package/dist/cjs/api/resources/files/client/requests/AgentSessionUploadFilePresignedUrlFilesSessionsSessionIdPresignedUrlPostRequest.js +3 -0
- package/dist/cjs/api/resources/files/client/requests/BrowserSessionUploadFilePresignedUrlFilesBrowsersSessionIdPresignedUrlPostRequest.d.ts +16 -0
- package/dist/cjs/api/resources/files/client/requests/BrowserSessionUploadFilePresignedUrlFilesBrowsersSessionIdPresignedUrlPostRequest.js +3 -0
- package/dist/cjs/api/resources/files/client/requests/GetTaskOutputFilePresignedUrlFilesTasksTaskIdOutputFilesFileIdGetRequest.d.ts +11 -0
- package/dist/cjs/api/resources/files/client/requests/GetTaskOutputFilePresignedUrlFilesTasksTaskIdOutputFilesFileIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/files/client/requests/index.d.ts +3 -1
- package/dist/cjs/api/resources/index.d.ts +11 -6
- package/dist/cjs/api/resources/index.js +12 -7
- package/dist/cjs/api/resources/profiles/client/Client.d.ts +32 -32
- package/dist/cjs/api/resources/profiles/client/Client.js +137 -40
- package/dist/cjs/api/resources/profiles/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/profiles/client/requests/DeleteBrowserProfileProfilesProfileIdDeleteRequest.d.ts +9 -0
- package/dist/cjs/api/resources/profiles/client/requests/DeleteBrowserProfileProfilesProfileIdDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/profiles/client/requests/GetProfileProfilesProfileIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/profiles/client/requests/GetProfileProfilesProfileIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/profiles/client/requests/ListProfilesProfilesGetRequest.d.ts +0 -3
- package/dist/cjs/api/resources/profiles/client/requests/ListProfilesProfilesGetRequest.js +1 -3
- package/dist/cjs/api/resources/profiles/client/requests/ProfileCreateRequest.d.ts +8 -0
- package/dist/cjs/api/resources/profiles/client/requests/ProfileCreateRequest.js +3 -0
- package/dist/cjs/api/resources/profiles/client/requests/ProfileUpdateRequest.d.ts +11 -0
- package/dist/cjs/api/resources/profiles/client/requests/ProfileUpdateRequest.js +3 -0
- package/dist/cjs/api/resources/profiles/client/requests/index.d.ts +5 -1
- package/dist/cjs/api/resources/sessions/client/Client.d.ts +28 -40
- package/dist/cjs/api/resources/sessions/client/Client.js +106 -69
- package/dist/cjs/api/resources/sessions/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/sessions/client/requests/CreateSessionPublicShareSessionsSessionIdPublicSharePostRequest.d.ts +9 -0
- package/dist/cjs/api/resources/sessions/client/requests/CreateSessionPublicShareSessionsSessionIdPublicSharePostRequest.js +3 -0
- package/dist/cjs/api/resources/sessions/client/requests/CreateSessionRequest.d.ts +5 -6
- package/dist/cjs/api/resources/sessions/client/requests/CreateSessionRequest.js +1 -3
- package/dist/cjs/api/resources/sessions/client/requests/DeleteSessionPublicShareSessionsSessionIdPublicShareDeleteRequest.d.ts +9 -0
- package/dist/cjs/api/resources/sessions/client/requests/DeleteSessionPublicShareSessionsSessionIdPublicShareDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/sessions/client/requests/GetSessionPublicShareSessionsSessionIdPublicShareGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/sessions/client/requests/GetSessionPublicShareSessionsSessionIdPublicShareGetRequest.js +3 -0
- package/dist/cjs/api/resources/sessions/client/requests/GetSessionSessionsSessionIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/sessions/client/requests/GetSessionSessionsSessionIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/sessions/client/requests/ListSessionsSessionsGetRequest.d.ts +2 -5
- package/dist/cjs/api/resources/sessions/client/requests/ListSessionsSessionsGetRequest.js +1 -3
- package/dist/cjs/api/resources/sessions/client/requests/UpdateSessionRequest.d.ts +4 -4
- package/dist/cjs/api/resources/sessions/client/requests/UpdateSessionRequest.js +1 -3
- package/dist/cjs/api/resources/sessions/client/requests/index.d.ts +7 -3
- package/dist/cjs/api/resources/tasks/client/Client.d.ts +17 -34
- package/dist/cjs/api/resources/tasks/client/Client.js +81 -55
- package/dist/cjs/api/resources/tasks/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tasks/client/requests/CreateTaskRequest.d.ts +19 -14
- package/dist/cjs/api/resources/tasks/client/requests/CreateTaskRequest.js +1 -3
- package/dist/cjs/api/resources/tasks/client/requests/GetTaskLogsTasksTaskIdLogsGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/tasks/client/requests/GetTaskLogsTasksTaskIdLogsGetRequest.js +3 -0
- package/dist/cjs/api/resources/tasks/client/requests/GetTaskTasksTaskIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/tasks/client/requests/GetTaskTasksTaskIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/tasks/client/requests/ListTasksTasksGetRequest.d.ts +5 -8
- package/dist/cjs/api/resources/tasks/client/requests/ListTasksTasksGetRequest.js +1 -3
- package/dist/cjs/api/resources/tasks/client/requests/UpdateTaskRequest.d.ts +3 -4
- package/dist/cjs/api/resources/tasks/client/requests/UpdateTaskRequest.js +1 -3
- package/dist/cjs/api/resources/tasks/client/requests/index.d.ts +5 -3
- package/dist/cjs/api/resources/workflows/client/Client.d.ts +221 -0
- package/dist/cjs/api/resources/workflows/client/Client.js +986 -0
- package/dist/cjs/api/resources/workflows/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/workflows/client/index.js +17 -0
- package/dist/cjs/api/resources/workflows/client/requests/CancelExecutionWorkflowsExecutionsExecutionIdCancelPatchRequest.d.ts +9 -0
- package/dist/cjs/api/resources/workflows/client/requests/CancelExecutionWorkflowsExecutionsExecutionIdCancelPatchRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/DeleteWorkflowWorkflowsWorkflowIdDeleteRequest.d.ts +9 -0
- package/dist/cjs/api/resources/workflows/client/requests/DeleteWorkflowWorkflowsWorkflowIdDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/GetExecutionLogsWorkflowsExecutionsExecutionIdLogsGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/workflows/client/requests/GetExecutionLogsWorkflowsExecutionsExecutionIdLogsGetRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/GetExecutionWorkflowsExecutionsExecutionIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/workflows/client/requests/GetExecutionWorkflowsExecutionsExecutionIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/GetWorkflowWorkflowsWorkflowIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/workflows/client/requests/GetWorkflowWorkflowsWorkflowIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/ListAllExecutionsWorkflowsExecutionsGetRequest.d.ts +11 -0
- package/dist/cjs/api/resources/workflows/client/requests/ListAllExecutionsWorkflowsExecutionsGetRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/ListWorkflowExecutionsWorkflowsWorkflowIdExecutionsGetRequest.d.ts +14 -0
- package/dist/cjs/api/resources/workflows/client/requests/ListWorkflowExecutionsWorkflowsWorkflowIdExecutionsGetRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/ListWorkflowsWorkflowsGetRequest.d.ts +10 -0
- package/dist/cjs/api/resources/workflows/client/requests/ListWorkflowsWorkflowsGetRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowCreateRequest.d.ts +14 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowCreateRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowExecuteRequest.d.ts +16 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowExecuteRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowGenerateRequest.d.ts +36 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowGenerateRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowUpdateRequest.d.ts +15 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowUpdateRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowYamlPresignedUploadRequest.d.ts +14 -0
- package/dist/cjs/api/resources/workflows/client/requests/WorkflowYamlPresignedUploadRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/index.d.ts +13 -0
- package/dist/cjs/api/resources/workflows/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/workflows/index.d.ts +2 -0
- package/dist/cjs/api/resources/workflows/index.js +18 -0
- package/dist/cjs/api/resources/workflows/types/ExecuteWorkflowWorkflowsWorkflowIdExecutePostResponse.d.ts +2 -0
- package/dist/cjs/api/resources/workflows/types/ExecuteWorkflowWorkflowsWorkflowIdExecutePostResponse.js +3 -0
- package/dist/cjs/api/resources/workflows/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/workflows/types/index.js +17 -0
- package/dist/cjs/api/types/AccountNotFoundError.d.ts +0 -3
- package/dist/cjs/api/types/AccountNotFoundError.js +1 -3
- package/dist/cjs/api/types/AccountView.d.ts +11 -9
- package/dist/cjs/api/types/AccountView.js +1 -3
- package/dist/cjs/api/types/BadRequestErrorBody.d.ts +1 -4
- package/dist/cjs/api/types/BadRequestErrorBody.js +1 -3
- package/dist/cjs/api/types/BrowserSessionItemView.d.ts +20 -0
- package/dist/cjs/api/types/BrowserSessionItemView.js +3 -0
- package/dist/cjs/api/types/BrowserSessionListResponse.d.ts +14 -0
- package/dist/cjs/api/types/BrowserSessionListResponse.js +3 -0
- package/dist/cjs/api/types/BrowserSessionStatus.d.ts +12 -0
- package/dist/cjs/api/types/BrowserSessionStatus.js +15 -0
- package/dist/cjs/api/types/BrowserSessionUpdateAction.d.ts +7 -0
- package/dist/cjs/api/types/BrowserSessionUpdateAction.js +3 -0
- package/dist/cjs/api/types/BrowserSessionView.d.ts +20 -0
- package/dist/cjs/api/types/BrowserSessionView.js +3 -0
- package/dist/cjs/api/types/DownloadUrlGenerationError.d.ts +0 -3
- package/dist/cjs/api/types/DownloadUrlGenerationError.js +1 -3
- package/dist/cjs/api/types/ExecutionMode.d.ts +12 -0
- package/dist/cjs/api/types/ExecutionMode.js +15 -0
- package/dist/cjs/api/types/FileView.d.ts +0 -3
- package/dist/cjs/api/types/FileView.js +1 -3
- package/dist/cjs/api/types/HttpValidationError.d.ts +1 -4
- package/dist/cjs/api/types/HttpValidationError.js +1 -3
- package/dist/cjs/api/types/InsufficientCreditsError.d.ts +0 -3
- package/dist/cjs/api/types/InsufficientCreditsError.js +1 -3
- package/dist/cjs/api/types/InternalServerErrorBody.d.ts +0 -3
- package/dist/cjs/api/types/InternalServerErrorBody.js +1 -3
- package/dist/cjs/api/types/NotFoundErrorBody.d.ts +1 -4
- package/dist/cjs/api/types/NotFoundErrorBody.js +1 -3
- package/dist/cjs/api/types/OutputFileNotFoundError.d.ts +0 -3
- package/dist/cjs/api/types/OutputFileNotFoundError.js +1 -3
- package/dist/cjs/api/types/PlanInfo.d.ts +15 -0
- package/dist/cjs/api/types/PlanInfo.js +3 -0
- package/dist/cjs/api/types/ProfileListResponse.d.ts +1 -4
- package/dist/cjs/api/types/ProfileListResponse.js +1 -3
- package/dist/cjs/api/types/ProfileNotFoundError.d.ts +0 -3
- package/dist/cjs/api/types/ProfileNotFoundError.js +1 -3
- package/dist/cjs/api/types/ProfileView.d.ts +5 -4
- package/dist/cjs/api/types/ProfileView.js +1 -3
- package/dist/cjs/api/types/ProxyCountryCode.d.ts +244 -10
- package/dist/cjs/api/types/ProxyCountryCode.js +244 -9
- package/dist/cjs/api/types/SessionHasRunningTaskError.d.ts +0 -3
- package/dist/cjs/api/types/SessionHasRunningTaskError.js +1 -3
- package/dist/cjs/api/types/SessionItemView.d.ts +3 -6
- package/dist/cjs/api/types/SessionItemView.js +1 -3
- package/dist/cjs/api/types/SessionListResponse.d.ts +1 -4
- package/dist/cjs/api/types/SessionListResponse.js +1 -3
- package/dist/cjs/api/types/SessionNotFoundError.d.ts +0 -3
- package/dist/cjs/api/types/SessionNotFoundError.js +1 -3
- package/dist/cjs/api/types/SessionStatus.d.ts +1 -4
- package/dist/cjs/api/types/SessionStatus.js +8 -3
- package/dist/cjs/api/types/SessionStoppedError.d.ts +0 -3
- package/dist/cjs/api/types/SessionStoppedError.js +1 -3
- package/dist/cjs/api/types/SessionTimeoutLimitExceededError.d.ts +6 -0
- package/dist/cjs/api/types/SessionTimeoutLimitExceededError.js +3 -0
- package/dist/cjs/api/types/SessionUpdateAction.d.ts +0 -3
- package/dist/cjs/api/types/SessionUpdateAction.js +1 -3
- package/dist/cjs/api/types/SessionView.d.ts +4 -7
- package/dist/cjs/api/types/SessionView.js +1 -3
- package/dist/cjs/api/types/ShareNotFoundError.d.ts +0 -3
- package/dist/cjs/api/types/ShareNotFoundError.js +1 -3
- package/dist/cjs/api/types/ShareView.d.ts +1 -4
- package/dist/cjs/api/types/ShareView.js +1 -3
- package/dist/cjs/api/types/SupportedLlMs.d.ts +5 -4
- package/dist/cjs/api/types/SupportedLlMs.js +5 -3
- package/dist/cjs/api/types/TaskCreatedResponse.d.ts +2 -3
- package/dist/cjs/api/types/TaskCreatedResponse.js +1 -3
- package/dist/cjs/api/types/TaskItemView.d.ts +9 -10
- package/dist/cjs/api/types/TaskItemView.js +1 -3
- package/dist/cjs/api/types/TaskListResponse.d.ts +1 -4
- package/dist/cjs/api/types/TaskListResponse.js +1 -3
- package/dist/cjs/api/types/TaskLogFileResponse.d.ts +0 -3
- package/dist/cjs/api/types/TaskLogFileResponse.js +1 -3
- package/dist/cjs/api/types/TaskNotFoundError.d.ts +0 -3
- package/dist/cjs/api/types/TaskNotFoundError.js +1 -3
- package/dist/cjs/api/types/TaskOutputFileResponse.d.ts +0 -3
- package/dist/cjs/api/types/TaskOutputFileResponse.js +1 -3
- package/dist/cjs/api/types/TaskStatus.d.ts +3 -6
- package/dist/cjs/api/types/TaskStatus.js +11 -4
- package/dist/cjs/api/types/TaskStepView.d.ts +1 -4
- package/dist/cjs/api/types/TaskStepView.js +1 -3
- package/dist/cjs/api/types/TaskUpdateAction.d.ts +1 -8
- package/dist/cjs/api/types/TaskUpdateAction.js +8 -5
- package/dist/cjs/api/types/TaskView.d.ts +9 -10
- package/dist/cjs/api/types/TaskView.js +1 -3
- package/dist/cjs/api/types/TooManyConcurrentActiveSessionsError.d.ts +0 -3
- package/dist/cjs/api/types/TooManyConcurrentActiveSessionsError.js +1 -3
- package/dist/cjs/api/types/UnsupportedContentTypeError.d.ts +0 -3
- package/dist/cjs/api/types/UnsupportedContentTypeError.js +1 -3
- package/dist/cjs/api/types/UploadFilePresignedUrlResponse.d.ts +0 -3
- package/dist/cjs/api/types/UploadFilePresignedUrlResponse.js +1 -3
- package/dist/cjs/api/{resources/files/client/requests → types}/UploadFileRequest.d.ts +3 -13
- package/dist/cjs/api/{resources/files/client/requests → types}/UploadFileRequest.js +2 -3
- package/dist/cjs/api/types/ValidationError.d.ts +0 -3
- package/dist/cjs/api/types/ValidationError.js +1 -3
- package/dist/cjs/api/types/WorkflowExecutionCreatedResponse.d.ts +12 -0
- package/dist/cjs/api/types/WorkflowExecutionCreatedResponse.js +3 -0
- package/dist/cjs/api/types/WorkflowExecutionItemView.d.ts +28 -0
- package/dist/cjs/api/types/WorkflowExecutionItemView.js +3 -0
- package/dist/cjs/api/types/WorkflowExecutionListResponse.d.ts +14 -0
- package/dist/cjs/api/types/WorkflowExecutionListResponse.js +3 -0
- package/dist/cjs/api/types/WorkflowExecutionLogResponse.d.ts +7 -0
- package/dist/cjs/api/types/WorkflowExecutionLogResponse.js +3 -0
- package/dist/cjs/api/types/WorkflowExecutionResponse.d.ts +38 -0
- package/dist/cjs/api/types/WorkflowExecutionResponse.js +3 -0
- package/dist/cjs/api/types/WorkflowExecutionStatus.d.ts +18 -0
- package/dist/cjs/api/types/WorkflowExecutionStatus.js +21 -0
- package/dist/cjs/api/types/WorkflowGenerateResponse.d.ts +11 -0
- package/dist/cjs/api/types/WorkflowGenerateResponse.js +3 -0
- package/dist/cjs/api/types/WorkflowGenerationStatus.d.ts +8 -0
- package/dist/cjs/api/types/WorkflowGenerationStatus.js +11 -0
- package/dist/cjs/api/types/WorkflowItemView.d.ts +19 -0
- package/dist/cjs/api/types/WorkflowItemView.js +3 -0
- package/dist/cjs/api/types/WorkflowListResponse.d.ts +14 -0
- package/dist/cjs/api/types/WorkflowListResponse.js +3 -0
- package/dist/cjs/api/types/WorkflowResponse.d.ts +38 -0
- package/dist/cjs/api/types/WorkflowResponse.js +3 -0
- package/dist/cjs/api/types/WorkflowYamlPresignedUploadResponse.d.ts +15 -0
- package/dist/cjs/api/types/WorkflowYamlPresignedUploadResponse.js +3 -0
- package/dist/cjs/api/types/index.d.ts +23 -2
- package/dist/cjs/api/types/index.js +23 -2
- package/dist/cjs/core/exports.d.ts +1 -0
- package/dist/cjs/core/exports.js +17 -0
- package/dist/cjs/core/fetcher/APIResponse.d.ts +1 -1
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +1 -1
- package/dist/cjs/core/fetcher/EndpointMetadata.d.ts +13 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.js +2 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +12 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.js +22 -0
- package/dist/cjs/core/fetcher/Fetcher.d.ts +9 -4
- package/dist/cjs/core/fetcher/Fetcher.js +205 -10
- package/dist/cjs/core/fetcher/HttpResponsePromise.d.ts +1 -1
- package/dist/cjs/core/fetcher/getErrorResponseBody.js +2 -1
- package/dist/cjs/core/fetcher/getRequestBody.d.ts +1 -1
- package/dist/cjs/core/fetcher/getRequestBody.js +4 -0
- package/dist/cjs/core/fetcher/getResponseBody.js +3 -3
- package/dist/cjs/core/fetcher/index.d.ts +2 -0
- package/dist/cjs/core/fetcher/index.js +3 -1
- package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -1
- package/dist/cjs/core/fetcher/makeRequest.js +2 -4
- package/dist/cjs/core/fetcher/requestWithRetries.js +35 -8
- package/dist/cjs/core/fetcher/signals.d.ts +0 -6
- package/dist/cjs/core/fetcher/signals.js +0 -12
- package/dist/cjs/core/headers.d.ts +2 -3
- package/dist/cjs/core/headers.js +6 -4
- package/dist/cjs/core/index.d.ts +1 -0
- package/dist/cjs/core/index.js +2 -1
- package/dist/cjs/core/logging/exports.d.ts +18 -0
- package/dist/cjs/core/logging/exports.js +45 -0
- package/dist/cjs/core/logging/index.d.ts +1 -0
- package/dist/cjs/core/logging/index.js +17 -0
- package/dist/cjs/core/logging/logger.d.ts +126 -0
- package/dist/cjs/core/logging/logger.js +144 -0
- package/dist/cjs/core/url/encodePathParam.d.ts +1 -0
- package/dist/cjs/core/url/encodePathParam.js +21 -0
- package/dist/cjs/core/url/index.d.ts +1 -0
- package/dist/cjs/core/url/index.js +3 -1
- package/dist/cjs/core/url/join.js +3 -4
- package/dist/cjs/environments.d.ts +0 -3
- package/dist/cjs/environments.js +1 -3
- package/dist/cjs/errors/BrowserUseError.d.ts +1 -4
- package/dist/cjs/errors/BrowserUseError.js +2 -4
- package/dist/cjs/errors/BrowserUseTimeoutError.d.ts +0 -3
- package/dist/cjs/errors/BrowserUseTimeoutError.js +1 -3
- package/dist/cjs/exports.d.ts +1 -0
- package/dist/cjs/exports.js +17 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/wrapper/api/BrowserUseTasks.d.ts +2 -2
- package/dist/cjs/wrapper/api/BrowserUseTasks.js +3 -3
- package/dist/cjs/wrapper/lib/parse.js +5 -18
- package/dist/cjs/wrapper/lib/webhooks.d.ts +24 -4
- package/dist/cjs/wrapper/lib/webhooks.js +2 -2
- package/dist/esm/BaseClient.d.mts +30 -0
- package/dist/esm/BaseClient.mjs +2 -0
- package/dist/esm/Client.d.mts +14 -28
- package/dist/esm/Client.mjs +21 -13
- package/dist/esm/api/errors/BadRequestError.d.mts +1 -4
- package/dist/esm/api/errors/BadRequestError.mjs +1 -3
- package/dist/esm/api/errors/ForbiddenError.d.mts +6 -0
- package/dist/esm/api/errors/ForbiddenError.mjs +13 -0
- package/dist/esm/api/errors/InternalServerError.d.mts +1 -4
- package/dist/esm/api/errors/InternalServerError.mjs +1 -3
- package/dist/esm/api/errors/NotFoundError.d.mts +1 -4
- package/dist/esm/api/errors/NotFoundError.mjs +1 -3
- package/dist/esm/api/errors/PaymentRequiredError.d.mts +2 -5
- package/dist/esm/api/errors/PaymentRequiredError.mjs +1 -3
- package/dist/esm/api/errors/TooManyRequestsError.d.mts +2 -5
- package/dist/esm/api/errors/TooManyRequestsError.mjs +1 -3
- package/dist/esm/api/errors/UnprocessableEntityError.d.mts +1 -4
- package/dist/esm/api/errors/UnprocessableEntityError.mjs +1 -3
- package/dist/esm/api/errors/index.d.mts +4 -3
- package/dist/esm/api/errors/index.mjs +4 -3
- package/dist/esm/api/index.d.mts +1 -1
- package/dist/esm/api/index.mjs +1 -1
- package/dist/esm/api/resources/billing/client/Client.d.mts +27 -0
- package/dist/esm/api/resources/{accounts → billing}/client/Client.mjs +21 -18
- package/dist/esm/api/resources/browsers/client/Client.d.mts +90 -0
- package/dist/esm/api/resources/browsers/client/Client.mjs +337 -0
- package/dist/esm/api/resources/browsers/client/index.d.mts +1 -0
- package/dist/esm/api/resources/browsers/client/index.mjs +1 -0
- package/dist/esm/api/resources/browsers/client/requests/CreateBrowserSessionRequest.d.mts +13 -0
- package/dist/esm/api/resources/browsers/client/requests/CreateBrowserSessionRequest.mjs +2 -0
- package/dist/esm/api/resources/browsers/client/requests/GetBrowserSessionBrowsersSessionIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/browsers/client/requests/GetBrowserSessionBrowsersSessionIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/browsers/client/requests/ListBrowserSessionsBrowsersGetRequest.d.mts +10 -0
- package/dist/esm/api/resources/browsers/client/requests/ListBrowserSessionsBrowsersGetRequest.mjs +2 -0
- package/dist/esm/api/resources/browsers/client/requests/UpdateBrowserSessionRequest.d.mts +9 -0
- package/dist/esm/api/resources/browsers/client/requests/UpdateBrowserSessionRequest.mjs +2 -0
- package/dist/esm/api/resources/browsers/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/browsers/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/browsers/index.d.mts +1 -0
- package/dist/esm/api/resources/browsers/index.mjs +1 -0
- package/dist/esm/api/resources/files/client/Client.d.mts +44 -38
- package/dist/esm/api/resources/files/client/Client.mjs +125 -33
- package/dist/esm/api/resources/files/client/index.d.mts +0 -1
- package/dist/esm/api/resources/files/client/requests/AgentSessionUploadFilePresignedUrlFilesSessionsSessionIdPresignedUrlPostRequest.d.mts +16 -0
- package/dist/esm/api/resources/files/client/requests/AgentSessionUploadFilePresignedUrlFilesSessionsSessionIdPresignedUrlPostRequest.mjs +2 -0
- package/dist/esm/api/resources/files/client/requests/BrowserSessionUploadFilePresignedUrlFilesBrowsersSessionIdPresignedUrlPostRequest.d.mts +16 -0
- package/dist/esm/api/resources/files/client/requests/BrowserSessionUploadFilePresignedUrlFilesBrowsersSessionIdPresignedUrlPostRequest.mjs +2 -0
- package/dist/esm/api/resources/files/client/requests/GetTaskOutputFilePresignedUrlFilesTasksTaskIdOutputFilesFileIdGetRequest.d.mts +11 -0
- package/dist/esm/api/resources/files/client/requests/GetTaskOutputFilePresignedUrlFilesTasksTaskIdOutputFilesFileIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/files/client/requests/index.d.mts +3 -1
- package/dist/esm/api/resources/index.d.mts +11 -6
- package/dist/esm/api/resources/index.mjs +11 -6
- package/dist/esm/api/resources/profiles/client/Client.d.mts +32 -32
- package/dist/esm/api/resources/profiles/client/Client.mjs +137 -40
- package/dist/esm/api/resources/profiles/client/index.d.mts +0 -1
- package/dist/esm/api/resources/profiles/client/requests/DeleteBrowserProfileProfilesProfileIdDeleteRequest.d.mts +9 -0
- package/dist/esm/api/resources/profiles/client/requests/DeleteBrowserProfileProfilesProfileIdDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/profiles/client/requests/GetProfileProfilesProfileIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/profiles/client/requests/GetProfileProfilesProfileIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/profiles/client/requests/ListProfilesProfilesGetRequest.d.mts +0 -3
- package/dist/esm/api/resources/profiles/client/requests/ListProfilesProfilesGetRequest.mjs +1 -3
- package/dist/esm/api/resources/profiles/client/requests/ProfileCreateRequest.d.mts +8 -0
- package/dist/esm/api/resources/profiles/client/requests/ProfileCreateRequest.mjs +2 -0
- package/dist/esm/api/resources/profiles/client/requests/ProfileUpdateRequest.d.mts +11 -0
- package/dist/esm/api/resources/profiles/client/requests/ProfileUpdateRequest.mjs +2 -0
- package/dist/esm/api/resources/profiles/client/requests/index.d.mts +5 -1
- package/dist/esm/api/resources/sessions/client/Client.d.mts +28 -40
- package/dist/esm/api/resources/sessions/client/Client.mjs +106 -69
- package/dist/esm/api/resources/sessions/client/index.d.mts +0 -1
- package/dist/esm/api/resources/sessions/client/requests/CreateSessionPublicShareSessionsSessionIdPublicSharePostRequest.d.mts +9 -0
- package/dist/esm/api/resources/sessions/client/requests/CreateSessionPublicShareSessionsSessionIdPublicSharePostRequest.mjs +2 -0
- package/dist/esm/api/resources/sessions/client/requests/CreateSessionRequest.d.mts +5 -6
- package/dist/esm/api/resources/sessions/client/requests/CreateSessionRequest.mjs +1 -3
- package/dist/esm/api/resources/sessions/client/requests/DeleteSessionPublicShareSessionsSessionIdPublicShareDeleteRequest.d.mts +9 -0
- package/dist/esm/api/resources/sessions/client/requests/DeleteSessionPublicShareSessionsSessionIdPublicShareDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/sessions/client/requests/GetSessionPublicShareSessionsSessionIdPublicShareGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/sessions/client/requests/GetSessionPublicShareSessionsSessionIdPublicShareGetRequest.mjs +2 -0
- package/dist/esm/api/resources/sessions/client/requests/GetSessionSessionsSessionIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/sessions/client/requests/GetSessionSessionsSessionIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/sessions/client/requests/ListSessionsSessionsGetRequest.d.mts +2 -5
- package/dist/esm/api/resources/sessions/client/requests/ListSessionsSessionsGetRequest.mjs +1 -3
- package/dist/esm/api/resources/sessions/client/requests/UpdateSessionRequest.d.mts +4 -4
- package/dist/esm/api/resources/sessions/client/requests/UpdateSessionRequest.mjs +1 -3
- package/dist/esm/api/resources/sessions/client/requests/index.d.mts +7 -3
- package/dist/esm/api/resources/tasks/client/Client.d.mts +17 -34
- package/dist/esm/api/resources/tasks/client/Client.mjs +81 -55
- package/dist/esm/api/resources/tasks/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tasks/client/requests/CreateTaskRequest.d.mts +19 -14
- package/dist/esm/api/resources/tasks/client/requests/CreateTaskRequest.mjs +1 -3
- package/dist/esm/api/resources/tasks/client/requests/GetTaskLogsTasksTaskIdLogsGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/tasks/client/requests/GetTaskLogsTasksTaskIdLogsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/tasks/client/requests/GetTaskTasksTaskIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/tasks/client/requests/GetTaskTasksTaskIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/tasks/client/requests/ListTasksTasksGetRequest.d.mts +5 -8
- package/dist/esm/api/resources/tasks/client/requests/ListTasksTasksGetRequest.mjs +1 -3
- package/dist/esm/api/resources/tasks/client/requests/UpdateTaskRequest.d.mts +3 -4
- package/dist/esm/api/resources/tasks/client/requests/UpdateTaskRequest.mjs +1 -3
- package/dist/esm/api/resources/tasks/client/requests/index.d.mts +5 -3
- package/dist/esm/api/resources/workflows/client/Client.d.mts +221 -0
- package/dist/esm/api/resources/workflows/client/Client.mjs +949 -0
- package/dist/esm/api/resources/workflows/client/index.d.mts +1 -0
- package/dist/esm/api/resources/workflows/client/index.mjs +1 -0
- package/dist/esm/api/resources/workflows/client/requests/CancelExecutionWorkflowsExecutionsExecutionIdCancelPatchRequest.d.mts +9 -0
- package/dist/esm/api/resources/workflows/client/requests/CancelExecutionWorkflowsExecutionsExecutionIdCancelPatchRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/DeleteWorkflowWorkflowsWorkflowIdDeleteRequest.d.mts +9 -0
- package/dist/esm/api/resources/workflows/client/requests/DeleteWorkflowWorkflowsWorkflowIdDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/GetExecutionLogsWorkflowsExecutionsExecutionIdLogsGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/workflows/client/requests/GetExecutionLogsWorkflowsExecutionsExecutionIdLogsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/GetExecutionWorkflowsExecutionsExecutionIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/workflows/client/requests/GetExecutionWorkflowsExecutionsExecutionIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/GetWorkflowWorkflowsWorkflowIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/workflows/client/requests/GetWorkflowWorkflowsWorkflowIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/ListAllExecutionsWorkflowsExecutionsGetRequest.d.mts +11 -0
- package/dist/esm/api/resources/workflows/client/requests/ListAllExecutionsWorkflowsExecutionsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/ListWorkflowExecutionsWorkflowsWorkflowIdExecutionsGetRequest.d.mts +14 -0
- package/dist/esm/api/resources/workflows/client/requests/ListWorkflowExecutionsWorkflowsWorkflowIdExecutionsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/ListWorkflowsWorkflowsGetRequest.d.mts +10 -0
- package/dist/esm/api/resources/workflows/client/requests/ListWorkflowsWorkflowsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowCreateRequest.d.mts +14 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowCreateRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowExecuteRequest.d.mts +16 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowExecuteRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowGenerateRequest.d.mts +36 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowGenerateRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowUpdateRequest.d.mts +15 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowUpdateRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowYamlPresignedUploadRequest.d.mts +14 -0
- package/dist/esm/api/resources/workflows/client/requests/WorkflowYamlPresignedUploadRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/index.d.mts +13 -0
- package/dist/esm/api/resources/workflows/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/workflows/index.d.mts +2 -0
- package/dist/esm/api/resources/workflows/index.mjs +2 -0
- package/dist/esm/api/resources/workflows/types/ExecuteWorkflowWorkflowsWorkflowIdExecutePostResponse.d.mts +2 -0
- package/dist/esm/api/resources/workflows/types/ExecuteWorkflowWorkflowsWorkflowIdExecutePostResponse.mjs +2 -0
- package/dist/esm/api/resources/workflows/types/index.d.mts +1 -0
- package/dist/esm/api/resources/workflows/types/index.mjs +1 -0
- package/dist/esm/api/types/AccountNotFoundError.d.mts +0 -3
- package/dist/esm/api/types/AccountNotFoundError.mjs +1 -3
- package/dist/esm/api/types/AccountView.d.mts +11 -9
- package/dist/esm/api/types/AccountView.mjs +1 -3
- package/dist/esm/api/types/BadRequestErrorBody.d.mts +1 -4
- package/dist/esm/api/types/BadRequestErrorBody.mjs +1 -3
- package/dist/esm/api/types/BrowserSessionItemView.d.mts +20 -0
- package/dist/esm/api/types/BrowserSessionItemView.mjs +2 -0
- package/dist/esm/api/types/BrowserSessionListResponse.d.mts +14 -0
- package/dist/esm/api/types/BrowserSessionListResponse.mjs +2 -0
- package/dist/esm/api/types/BrowserSessionStatus.d.mts +12 -0
- package/dist/esm/api/types/BrowserSessionStatus.mjs +12 -0
- package/dist/esm/api/types/BrowserSessionUpdateAction.d.mts +7 -0
- package/dist/esm/api/types/BrowserSessionUpdateAction.mjs +2 -0
- package/dist/esm/api/types/BrowserSessionView.d.mts +20 -0
- package/dist/esm/api/types/BrowserSessionView.mjs +2 -0
- package/dist/esm/api/types/DownloadUrlGenerationError.d.mts +0 -3
- package/dist/esm/api/types/DownloadUrlGenerationError.mjs +1 -3
- package/dist/esm/api/types/ExecutionMode.d.mts +12 -0
- package/dist/esm/api/types/ExecutionMode.mjs +12 -0
- package/dist/esm/api/types/FileView.d.mts +0 -3
- package/dist/esm/api/types/FileView.mjs +1 -3
- package/dist/esm/api/types/HttpValidationError.d.mts +1 -4
- package/dist/esm/api/types/HttpValidationError.mjs +1 -3
- package/dist/esm/api/types/InsufficientCreditsError.d.mts +0 -3
- package/dist/esm/api/types/InsufficientCreditsError.mjs +1 -3
- package/dist/esm/api/types/InternalServerErrorBody.d.mts +0 -3
- package/dist/esm/api/types/InternalServerErrorBody.mjs +1 -3
- package/dist/esm/api/types/NotFoundErrorBody.d.mts +1 -4
- package/dist/esm/api/types/NotFoundErrorBody.mjs +1 -3
- package/dist/esm/api/types/OutputFileNotFoundError.d.mts +0 -3
- package/dist/esm/api/types/OutputFileNotFoundError.mjs +1 -3
- package/dist/esm/api/types/PlanInfo.d.mts +15 -0
- package/dist/esm/api/types/PlanInfo.mjs +2 -0
- package/dist/esm/api/types/ProfileListResponse.d.mts +1 -4
- package/dist/esm/api/types/ProfileListResponse.mjs +1 -3
- package/dist/esm/api/types/ProfileNotFoundError.d.mts +0 -3
- package/dist/esm/api/types/ProfileNotFoundError.mjs +1 -3
- package/dist/esm/api/types/ProfileView.d.mts +5 -4
- package/dist/esm/api/types/ProfileView.mjs +1 -3
- package/dist/esm/api/types/ProxyCountryCode.d.mts +244 -10
- package/dist/esm/api/types/ProxyCountryCode.mjs +244 -9
- package/dist/esm/api/types/SessionHasRunningTaskError.d.mts +0 -3
- package/dist/esm/api/types/SessionHasRunningTaskError.mjs +1 -3
- package/dist/esm/api/types/SessionItemView.d.mts +3 -6
- package/dist/esm/api/types/SessionItemView.mjs +1 -3
- package/dist/esm/api/types/SessionListResponse.d.mts +1 -4
- package/dist/esm/api/types/SessionListResponse.mjs +1 -3
- package/dist/esm/api/types/SessionNotFoundError.d.mts +0 -3
- package/dist/esm/api/types/SessionNotFoundError.mjs +1 -3
- package/dist/esm/api/types/SessionStatus.d.mts +1 -4
- package/dist/esm/api/types/SessionStatus.mjs +6 -1
- package/dist/esm/api/types/SessionStoppedError.d.mts +0 -3
- package/dist/esm/api/types/SessionStoppedError.mjs +1 -3
- package/dist/esm/api/types/SessionTimeoutLimitExceededError.d.mts +6 -0
- package/dist/esm/api/types/SessionTimeoutLimitExceededError.mjs +2 -0
- package/dist/esm/api/types/SessionUpdateAction.d.mts +0 -3
- package/dist/esm/api/types/SessionUpdateAction.mjs +1 -3
- package/dist/esm/api/types/SessionView.d.mts +4 -7
- package/dist/esm/api/types/SessionView.mjs +1 -3
- package/dist/esm/api/types/ShareNotFoundError.d.mts +0 -3
- package/dist/esm/api/types/ShareNotFoundError.mjs +1 -3
- package/dist/esm/api/types/ShareView.d.mts +1 -4
- package/dist/esm/api/types/ShareView.mjs +1 -3
- package/dist/esm/api/types/SupportedLlMs.d.mts +5 -4
- package/dist/esm/api/types/SupportedLlMs.mjs +5 -3
- package/dist/esm/api/types/TaskCreatedResponse.d.mts +2 -3
- package/dist/esm/api/types/TaskCreatedResponse.mjs +1 -3
- package/dist/esm/api/types/TaskItemView.d.mts +9 -10
- package/dist/esm/api/types/TaskItemView.mjs +1 -3
- package/dist/esm/api/types/TaskListResponse.d.mts +1 -4
- package/dist/esm/api/types/TaskListResponse.mjs +1 -3
- package/dist/esm/api/types/TaskLogFileResponse.d.mts +0 -3
- package/dist/esm/api/types/TaskLogFileResponse.mjs +1 -3
- package/dist/esm/api/types/TaskNotFoundError.d.mts +0 -3
- package/dist/esm/api/types/TaskNotFoundError.mjs +1 -3
- package/dist/esm/api/types/TaskOutputFileResponse.d.mts +0 -3
- package/dist/esm/api/types/TaskOutputFileResponse.mjs +1 -3
- package/dist/esm/api/types/TaskStatus.d.mts +3 -6
- package/dist/esm/api/types/TaskStatus.mjs +9 -2
- package/dist/esm/api/types/TaskStepView.d.mts +1 -4
- package/dist/esm/api/types/TaskStepView.mjs +1 -3
- package/dist/esm/api/types/TaskUpdateAction.d.mts +1 -8
- package/dist/esm/api/types/TaskUpdateAction.mjs +6 -3
- package/dist/esm/api/types/TaskView.d.mts +9 -10
- package/dist/esm/api/types/TaskView.mjs +1 -3
- package/dist/esm/api/types/TooManyConcurrentActiveSessionsError.d.mts +0 -3
- package/dist/esm/api/types/TooManyConcurrentActiveSessionsError.mjs +1 -3
- package/dist/esm/api/types/UnsupportedContentTypeError.d.mts +0 -3
- package/dist/esm/api/types/UnsupportedContentTypeError.mjs +1 -3
- package/dist/esm/api/types/UploadFilePresignedUrlResponse.d.mts +0 -3
- package/dist/esm/api/types/UploadFilePresignedUrlResponse.mjs +1 -3
- package/dist/esm/api/{resources/files/client/requests → types}/UploadFileRequest.d.mts +3 -13
- package/dist/esm/api/{resources/files/client/requests → types}/UploadFileRequest.mjs +2 -3
- package/dist/esm/api/types/ValidationError.d.mts +0 -3
- package/dist/esm/api/types/ValidationError.mjs +1 -3
- package/dist/esm/api/types/WorkflowExecutionCreatedResponse.d.mts +12 -0
- package/dist/esm/api/types/WorkflowExecutionCreatedResponse.mjs +2 -0
- package/dist/esm/api/types/WorkflowExecutionItemView.d.mts +28 -0
- package/dist/esm/api/types/WorkflowExecutionItemView.mjs +2 -0
- package/dist/esm/api/types/WorkflowExecutionListResponse.d.mts +14 -0
- package/dist/esm/api/types/WorkflowExecutionListResponse.mjs +2 -0
- package/dist/esm/api/types/WorkflowExecutionLogResponse.d.mts +7 -0
- package/dist/esm/api/types/WorkflowExecutionLogResponse.mjs +2 -0
- package/dist/esm/api/types/WorkflowExecutionResponse.d.mts +38 -0
- package/dist/esm/api/types/WorkflowExecutionResponse.mjs +2 -0
- package/dist/esm/api/types/WorkflowExecutionStatus.d.mts +18 -0
- package/dist/esm/api/types/WorkflowExecutionStatus.mjs +18 -0
- package/dist/esm/api/types/WorkflowGenerateResponse.d.mts +11 -0
- package/dist/esm/api/types/WorkflowGenerateResponse.mjs +2 -0
- package/dist/esm/api/types/WorkflowGenerationStatus.d.mts +8 -0
- package/dist/esm/api/types/WorkflowGenerationStatus.mjs +8 -0
- package/dist/esm/api/types/WorkflowItemView.d.mts +19 -0
- package/dist/esm/api/types/WorkflowItemView.mjs +2 -0
- package/dist/esm/api/types/WorkflowListResponse.d.mts +14 -0
- package/dist/esm/api/types/WorkflowListResponse.mjs +2 -0
- package/dist/esm/api/types/WorkflowResponse.d.mts +38 -0
- package/dist/esm/api/types/WorkflowResponse.mjs +2 -0
- package/dist/esm/api/types/WorkflowYamlPresignedUploadResponse.d.mts +15 -0
- package/dist/esm/api/types/WorkflowYamlPresignedUploadResponse.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +23 -2
- package/dist/esm/api/types/index.mjs +23 -2
- package/dist/esm/core/exports.d.mts +1 -0
- package/dist/esm/core/exports.mjs +1 -0
- package/dist/esm/core/fetcher/APIResponse.d.mts +1 -1
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +1 -1
- package/dist/esm/core/fetcher/EndpointMetadata.d.mts +13 -0
- package/dist/esm/core/fetcher/EndpointMetadata.mjs +1 -0
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +12 -0
- package/dist/esm/core/fetcher/EndpointSupplier.mjs +19 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +9 -4
- package/dist/esm/core/fetcher/Fetcher.mjs +205 -10
- package/dist/esm/core/fetcher/HttpResponsePromise.d.mts +1 -1
- package/dist/esm/core/fetcher/getErrorResponseBody.mjs +2 -1
- package/dist/esm/core/fetcher/getRequestBody.d.mts +1 -1
- package/dist/esm/core/fetcher/getRequestBody.mjs +4 -0
- package/dist/esm/core/fetcher/getResponseBody.mjs +3 -3
- package/dist/esm/core/fetcher/index.d.mts +2 -0
- package/dist/esm/core/fetcher/index.mjs +1 -0
- package/dist/esm/core/fetcher/makeRequest.d.mts +1 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +2 -4
- package/dist/esm/core/fetcher/requestWithRetries.mjs +35 -8
- package/dist/esm/core/fetcher/signals.d.mts +0 -6
- package/dist/esm/core/fetcher/signals.mjs +0 -12
- package/dist/esm/core/headers.d.mts +2 -3
- package/dist/esm/core/headers.mjs +6 -4
- package/dist/esm/core/index.d.mts +1 -0
- package/dist/esm/core/index.mjs +1 -0
- package/dist/esm/core/logging/exports.d.mts +18 -0
- package/dist/esm/core/logging/exports.mjs +9 -0
- package/dist/esm/core/logging/index.d.mts +1 -0
- package/dist/esm/core/logging/index.mjs +1 -0
- package/dist/esm/core/logging/logger.d.mts +126 -0
- package/dist/esm/core/logging/logger.mjs +138 -0
- package/dist/esm/core/url/encodePathParam.d.mts +1 -0
- package/dist/esm/core/url/encodePathParam.mjs +18 -0
- package/dist/esm/core/url/index.d.mts +1 -0
- package/dist/esm/core/url/index.mjs +1 -0
- package/dist/esm/core/url/join.mjs +3 -4
- package/dist/esm/environments.d.mts +0 -3
- package/dist/esm/environments.mjs +1 -3
- package/dist/esm/errors/BrowserUseError.d.mts +1 -4
- package/dist/esm/errors/BrowserUseError.mjs +2 -4
- package/dist/esm/errors/BrowserUseTimeoutError.d.mts +0 -3
- package/dist/esm/errors/BrowserUseTimeoutError.mjs +1 -3
- package/dist/esm/exports.d.mts +1 -0
- package/dist/esm/exports.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/esm/wrapper/api/BrowserUseTasks.d.mts +2 -2
- package/dist/esm/wrapper/api/BrowserUseTasks.mjs +4 -3
- package/dist/esm/wrapper/lib/parse.mjs +6 -19
- package/dist/esm/wrapper/lib/webhooks.d.mts +24 -4
- package/dist/esm/wrapper/lib/webhooks.mjs +2 -2
- package/package.json +15 -15
- package/reference.md +1434 -174
- package/dist/cjs/api/resources/accounts/client/Client.d.ts +0 -47
- package/dist/esm/api/resources/accounts/client/Client.d.mts +0 -47
- /package/dist/cjs/api/resources/{accounts → billing}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{accounts → billing}/client/index.js +0 -0
- /package/dist/cjs/api/resources/{accounts → billing}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{accounts → billing}/index.js +0 -0
- /package/dist/esm/api/resources/{accounts → billing}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/{accounts → billing}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/{accounts → billing}/index.d.mts +0 -0
- /package/dist/esm/api/resources/{accounts → billing}/index.mjs +0 -0
package/reference.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">getAccountMe</a>() -> BrowserUse.AccountView</code></summary>
|
|
2
|
+
## Billing
|
|
3
|
+
<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">getAccountBilling</a>() -> BrowserUse.AccountView</code></summary>
|
|
6
4
|
<dl>
|
|
7
5
|
<dd>
|
|
8
6
|
|
|
@@ -15,7 +13,6 @@
|
|
|
15
13
|
<dd>
|
|
16
14
|
|
|
17
15
|
Get authenticated account information including credit balances and account details.
|
|
18
|
-
|
|
19
16
|
</dd>
|
|
20
17
|
</dl>
|
|
21
18
|
</dd>
|
|
@@ -30,9 +27,9 @@ Get authenticated account information including credit balances and account deta
|
|
|
30
27
|
<dd>
|
|
31
28
|
|
|
32
29
|
```typescript
|
|
33
|
-
await client.
|
|
34
|
-
```
|
|
30
|
+
await client.billing.getAccountBilling();
|
|
35
31
|
|
|
32
|
+
```
|
|
36
33
|
</dd>
|
|
37
34
|
</dl>
|
|
38
35
|
</dd>
|
|
@@ -46,19 +43,19 @@ await client.accounts.getAccountMe();
|
|
|
46
43
|
<dl>
|
|
47
44
|
<dd>
|
|
48
45
|
|
|
49
|
-
**requestOptions:** `
|
|
50
|
-
|
|
46
|
+
**requestOptions:** `Billing.RequestOptions`
|
|
47
|
+
|
|
51
48
|
</dd>
|
|
52
49
|
</dl>
|
|
53
50
|
</dd>
|
|
54
51
|
</dl>
|
|
55
52
|
|
|
53
|
+
|
|
56
54
|
</dd>
|
|
57
55
|
</dl>
|
|
58
56
|
</details>
|
|
59
57
|
|
|
60
58
|
## Tasks
|
|
61
|
-
|
|
62
59
|
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">listTasks</a>({ ...params }) -> BrowserUse.TaskListResponse</code></summary>
|
|
63
60
|
<dl>
|
|
64
61
|
<dd>
|
|
@@ -72,7 +69,6 @@ await client.accounts.getAccountMe();
|
|
|
72
69
|
<dd>
|
|
73
70
|
|
|
74
71
|
Get paginated list of AI agent tasks with optional filtering by session and status.
|
|
75
|
-
|
|
76
72
|
</dd>
|
|
77
73
|
</dl>
|
|
78
74
|
</dd>
|
|
@@ -88,8 +84,8 @@ Get paginated list of AI agent tasks with optional filtering by session and stat
|
|
|
88
84
|
|
|
89
85
|
```typescript
|
|
90
86
|
await client.tasks.listTasks();
|
|
91
|
-
```
|
|
92
87
|
|
|
88
|
+
```
|
|
93
89
|
</dd>
|
|
94
90
|
</dl>
|
|
95
91
|
</dd>
|
|
@@ -103,21 +99,22 @@ await client.tasks.listTasks();
|
|
|
103
99
|
<dl>
|
|
104
100
|
<dd>
|
|
105
101
|
|
|
106
|
-
**request:** `BrowserUse.ListTasksTasksGetRequest`
|
|
107
|
-
|
|
102
|
+
**request:** `BrowserUse.ListTasksTasksGetRequest`
|
|
103
|
+
|
|
108
104
|
</dd>
|
|
109
105
|
</dl>
|
|
110
106
|
|
|
111
107
|
<dl>
|
|
112
108
|
<dd>
|
|
113
109
|
|
|
114
|
-
**requestOptions:** `Tasks.RequestOptions`
|
|
115
|
-
|
|
110
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
111
|
+
|
|
116
112
|
</dd>
|
|
117
113
|
</dl>
|
|
118
114
|
</dd>
|
|
119
115
|
</dl>
|
|
120
116
|
|
|
117
|
+
|
|
121
118
|
</dd>
|
|
122
119
|
</dl>
|
|
123
120
|
</details>
|
|
@@ -135,13 +132,12 @@ await client.tasks.listTasks();
|
|
|
135
132
|
<dd>
|
|
136
133
|
|
|
137
134
|
You can either:
|
|
138
|
-
|
|
139
135
|
1. Start a new task (auto creates a new simple session)
|
|
140
136
|
2. Start a new task in an existing session (you can create a custom session before starting the task and reuse it for follow-up tasks)
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
137
|
+
</dd>
|
|
138
|
+
</dl>
|
|
139
|
+
</dd>
|
|
140
|
+
</dl>
|
|
145
141
|
|
|
146
142
|
#### 🔌 Usage
|
|
147
143
|
|
|
@@ -153,10 +149,10 @@ You can either:
|
|
|
153
149
|
|
|
154
150
|
```typescript
|
|
155
151
|
await client.tasks.createTask({
|
|
156
|
-
task: "task"
|
|
152
|
+
task: "task"
|
|
157
153
|
});
|
|
158
|
-
```
|
|
159
154
|
|
|
155
|
+
```
|
|
160
156
|
</dd>
|
|
161
157
|
</dl>
|
|
162
158
|
</dd>
|
|
@@ -170,26 +166,27 @@ await client.tasks.createTask({
|
|
|
170
166
|
<dl>
|
|
171
167
|
<dd>
|
|
172
168
|
|
|
173
|
-
**request:** `BrowserUse.CreateTaskRequest`
|
|
174
|
-
|
|
169
|
+
**request:** `BrowserUse.CreateTaskRequest`
|
|
170
|
+
|
|
175
171
|
</dd>
|
|
176
172
|
</dl>
|
|
177
173
|
|
|
178
174
|
<dl>
|
|
179
175
|
<dd>
|
|
180
176
|
|
|
181
|
-
**requestOptions:** `Tasks.RequestOptions`
|
|
182
|
-
|
|
177
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
178
|
+
|
|
183
179
|
</dd>
|
|
184
180
|
</dl>
|
|
185
181
|
</dd>
|
|
186
182
|
</dl>
|
|
187
183
|
|
|
184
|
+
|
|
188
185
|
</dd>
|
|
189
186
|
</dl>
|
|
190
187
|
</details>
|
|
191
188
|
|
|
192
|
-
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getTask</a>(
|
|
189
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getTask</a>({ ...params }) -> BrowserUse.TaskView</code></summary>
|
|
193
190
|
<dl>
|
|
194
191
|
<dd>
|
|
195
192
|
|
|
@@ -202,7 +199,6 @@ await client.tasks.createTask({
|
|
|
202
199
|
<dd>
|
|
203
200
|
|
|
204
201
|
Get detailed task information including status, progress, steps, and file outputs.
|
|
205
|
-
|
|
206
202
|
</dd>
|
|
207
203
|
</dl>
|
|
208
204
|
</dd>
|
|
@@ -217,9 +213,11 @@ Get detailed task information including status, progress, steps, and file output
|
|
|
217
213
|
<dd>
|
|
218
214
|
|
|
219
215
|
```typescript
|
|
220
|
-
await client.tasks.getTask(
|
|
221
|
-
|
|
216
|
+
await client.tasks.getTask({
|
|
217
|
+
task_id: "task_id"
|
|
218
|
+
});
|
|
222
219
|
|
|
220
|
+
```
|
|
223
221
|
</dd>
|
|
224
222
|
</dl>
|
|
225
223
|
</dd>
|
|
@@ -233,26 +231,27 @@ await client.tasks.getTask("task_id");
|
|
|
233
231
|
<dl>
|
|
234
232
|
<dd>
|
|
235
233
|
|
|
236
|
-
**
|
|
237
|
-
|
|
234
|
+
**request:** `BrowserUse.GetTaskTasksTaskIdGetRequest`
|
|
235
|
+
|
|
238
236
|
</dd>
|
|
239
237
|
</dl>
|
|
240
238
|
|
|
241
239
|
<dl>
|
|
242
240
|
<dd>
|
|
243
241
|
|
|
244
|
-
**requestOptions:** `Tasks.RequestOptions`
|
|
245
|
-
|
|
242
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
243
|
+
|
|
246
244
|
</dd>
|
|
247
245
|
</dl>
|
|
248
246
|
</dd>
|
|
249
247
|
</dl>
|
|
250
248
|
|
|
249
|
+
|
|
251
250
|
</dd>
|
|
252
251
|
</dl>
|
|
253
252
|
</details>
|
|
254
253
|
|
|
255
|
-
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">updateTask</a>(
|
|
254
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">updateTask</a>({ ...params }) -> BrowserUse.TaskView</code></summary>
|
|
256
255
|
<dl>
|
|
257
256
|
<dd>
|
|
258
257
|
|
|
@@ -265,7 +264,6 @@ await client.tasks.getTask("task_id");
|
|
|
265
264
|
<dd>
|
|
266
265
|
|
|
267
266
|
Control task execution with stop, pause, resume, or stop task and session actions.
|
|
268
|
-
|
|
269
267
|
</dd>
|
|
270
268
|
</dl>
|
|
271
269
|
</dd>
|
|
@@ -280,11 +278,12 @@ Control task execution with stop, pause, resume, or stop task and session action
|
|
|
280
278
|
<dd>
|
|
281
279
|
|
|
282
280
|
```typescript
|
|
283
|
-
await client.tasks.updateTask(
|
|
284
|
-
|
|
281
|
+
await client.tasks.updateTask({
|
|
282
|
+
task_id: "task_id",
|
|
283
|
+
action: "stop"
|
|
285
284
|
});
|
|
286
|
-
```
|
|
287
285
|
|
|
286
|
+
```
|
|
288
287
|
</dd>
|
|
289
288
|
</dl>
|
|
290
289
|
</dd>
|
|
@@ -298,34 +297,27 @@ await client.tasks.updateTask("task_id", {
|
|
|
298
297
|
<dl>
|
|
299
298
|
<dd>
|
|
300
299
|
|
|
301
|
-
**
|
|
302
|
-
|
|
303
|
-
</dd>
|
|
304
|
-
</dl>
|
|
305
|
-
|
|
306
|
-
<dl>
|
|
307
|
-
<dd>
|
|
308
|
-
|
|
309
|
-
**request:** `BrowserUse.UpdateTaskRequest`
|
|
310
|
-
|
|
300
|
+
**request:** `BrowserUse.UpdateTaskRequest`
|
|
301
|
+
|
|
311
302
|
</dd>
|
|
312
303
|
</dl>
|
|
313
304
|
|
|
314
305
|
<dl>
|
|
315
306
|
<dd>
|
|
316
307
|
|
|
317
|
-
**requestOptions:** `Tasks.RequestOptions`
|
|
318
|
-
|
|
308
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
309
|
+
|
|
319
310
|
</dd>
|
|
320
311
|
</dl>
|
|
321
312
|
</dd>
|
|
322
313
|
</dl>
|
|
323
314
|
|
|
315
|
+
|
|
324
316
|
</dd>
|
|
325
317
|
</dl>
|
|
326
318
|
</details>
|
|
327
319
|
|
|
328
|
-
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getTaskLogs</a>(
|
|
320
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getTaskLogs</a>({ ...params }) -> BrowserUse.TaskLogFileResponse</code></summary>
|
|
329
321
|
<dl>
|
|
330
322
|
<dd>
|
|
331
323
|
|
|
@@ -338,7 +330,6 @@ await client.tasks.updateTask("task_id", {
|
|
|
338
330
|
<dd>
|
|
339
331
|
|
|
340
332
|
Get secure download URL for task execution logs with step-by-step details.
|
|
341
|
-
|
|
342
333
|
</dd>
|
|
343
334
|
</dl>
|
|
344
335
|
</dd>
|
|
@@ -353,9 +344,11 @@ Get secure download URL for task execution logs with step-by-step details.
|
|
|
353
344
|
<dd>
|
|
354
345
|
|
|
355
346
|
```typescript
|
|
356
|
-
await client.tasks.getTaskLogs(
|
|
357
|
-
|
|
347
|
+
await client.tasks.getTaskLogs({
|
|
348
|
+
task_id: "task_id"
|
|
349
|
+
});
|
|
358
350
|
|
|
351
|
+
```
|
|
359
352
|
</dd>
|
|
360
353
|
</dl>
|
|
361
354
|
</dd>
|
|
@@ -369,27 +362,27 @@ await client.tasks.getTaskLogs("task_id");
|
|
|
369
362
|
<dl>
|
|
370
363
|
<dd>
|
|
371
364
|
|
|
372
|
-
**
|
|
373
|
-
|
|
365
|
+
**request:** `BrowserUse.GetTaskLogsTasksTaskIdLogsGetRequest`
|
|
366
|
+
|
|
374
367
|
</dd>
|
|
375
368
|
</dl>
|
|
376
369
|
|
|
377
370
|
<dl>
|
|
378
371
|
<dd>
|
|
379
372
|
|
|
380
|
-
**requestOptions:** `Tasks.RequestOptions`
|
|
381
|
-
|
|
373
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
374
|
+
|
|
382
375
|
</dd>
|
|
383
376
|
</dl>
|
|
384
377
|
</dd>
|
|
385
378
|
</dl>
|
|
386
379
|
|
|
380
|
+
|
|
387
381
|
</dd>
|
|
388
382
|
</dl>
|
|
389
383
|
</details>
|
|
390
384
|
|
|
391
385
|
## Sessions
|
|
392
|
-
|
|
393
386
|
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">listSessions</a>({ ...params }) -> BrowserUse.SessionListResponse</code></summary>
|
|
394
387
|
<dl>
|
|
395
388
|
<dd>
|
|
@@ -403,7 +396,6 @@ await client.tasks.getTaskLogs("task_id");
|
|
|
403
396
|
<dd>
|
|
404
397
|
|
|
405
398
|
Get paginated list of AI agent sessions with optional status filtering.
|
|
406
|
-
|
|
407
399
|
</dd>
|
|
408
400
|
</dl>
|
|
409
401
|
</dd>
|
|
@@ -419,8 +411,8 @@ Get paginated list of AI agent sessions with optional status filtering.
|
|
|
419
411
|
|
|
420
412
|
```typescript
|
|
421
413
|
await client.sessions.listSessions();
|
|
422
|
-
```
|
|
423
414
|
|
|
415
|
+
```
|
|
424
416
|
</dd>
|
|
425
417
|
</dl>
|
|
426
418
|
</dd>
|
|
@@ -434,21 +426,22 @@ await client.sessions.listSessions();
|
|
|
434
426
|
<dl>
|
|
435
427
|
<dd>
|
|
436
428
|
|
|
437
|
-
**request:** `BrowserUse.ListSessionsSessionsGetRequest`
|
|
438
|
-
|
|
429
|
+
**request:** `BrowserUse.ListSessionsSessionsGetRequest`
|
|
430
|
+
|
|
439
431
|
</dd>
|
|
440
432
|
</dl>
|
|
441
433
|
|
|
442
434
|
<dl>
|
|
443
435
|
<dd>
|
|
444
436
|
|
|
445
|
-
**requestOptions:** `Sessions.RequestOptions`
|
|
446
|
-
|
|
437
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
438
|
+
|
|
447
439
|
</dd>
|
|
448
440
|
</dl>
|
|
449
441
|
</dd>
|
|
450
442
|
</dl>
|
|
451
443
|
|
|
444
|
+
|
|
452
445
|
</dd>
|
|
453
446
|
</dl>
|
|
454
447
|
</details>
|
|
@@ -466,7 +459,6 @@ await client.sessions.listSessions();
|
|
|
466
459
|
<dd>
|
|
467
460
|
|
|
468
461
|
Create a new session with a new task.
|
|
469
|
-
|
|
470
462
|
</dd>
|
|
471
463
|
</dl>
|
|
472
464
|
</dd>
|
|
@@ -482,8 +474,8 @@ Create a new session with a new task.
|
|
|
482
474
|
|
|
483
475
|
```typescript
|
|
484
476
|
await client.sessions.createSession();
|
|
485
|
-
```
|
|
486
477
|
|
|
478
|
+
```
|
|
487
479
|
</dd>
|
|
488
480
|
</dl>
|
|
489
481
|
</dd>
|
|
@@ -497,26 +489,27 @@ await client.sessions.createSession();
|
|
|
497
489
|
<dl>
|
|
498
490
|
<dd>
|
|
499
491
|
|
|
500
|
-
**request:** `BrowserUse.CreateSessionRequest`
|
|
501
|
-
|
|
492
|
+
**request:** `BrowserUse.CreateSessionRequest`
|
|
493
|
+
|
|
502
494
|
</dd>
|
|
503
495
|
</dl>
|
|
504
496
|
|
|
505
497
|
<dl>
|
|
506
498
|
<dd>
|
|
507
499
|
|
|
508
|
-
**requestOptions:** `Sessions.RequestOptions`
|
|
509
|
-
|
|
500
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
501
|
+
|
|
510
502
|
</dd>
|
|
511
503
|
</dl>
|
|
512
504
|
</dd>
|
|
513
505
|
</dl>
|
|
514
506
|
|
|
507
|
+
|
|
515
508
|
</dd>
|
|
516
509
|
</dl>
|
|
517
510
|
</details>
|
|
518
511
|
|
|
519
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getSession</a>(
|
|
512
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getSession</a>({ ...params }) -> BrowserUse.SessionView</code></summary>
|
|
520
513
|
<dl>
|
|
521
514
|
<dd>
|
|
522
515
|
|
|
@@ -529,7 +522,6 @@ await client.sessions.createSession();
|
|
|
529
522
|
<dd>
|
|
530
523
|
|
|
531
524
|
Get detailed session information including status, URLs, and task details.
|
|
532
|
-
|
|
533
525
|
</dd>
|
|
534
526
|
</dl>
|
|
535
527
|
</dd>
|
|
@@ -544,9 +536,11 @@ Get detailed session information including status, URLs, and task details.
|
|
|
544
536
|
<dd>
|
|
545
537
|
|
|
546
538
|
```typescript
|
|
547
|
-
await client.sessions.getSession(
|
|
548
|
-
|
|
539
|
+
await client.sessions.getSession({
|
|
540
|
+
session_id: "session_id"
|
|
541
|
+
});
|
|
549
542
|
|
|
543
|
+
```
|
|
550
544
|
</dd>
|
|
551
545
|
</dl>
|
|
552
546
|
</dd>
|
|
@@ -560,26 +554,27 @@ await client.sessions.getSession("session_id");
|
|
|
560
554
|
<dl>
|
|
561
555
|
<dd>
|
|
562
556
|
|
|
563
|
-
**
|
|
564
|
-
|
|
557
|
+
**request:** `BrowserUse.GetSessionSessionsSessionIdGetRequest`
|
|
558
|
+
|
|
565
559
|
</dd>
|
|
566
560
|
</dl>
|
|
567
561
|
|
|
568
562
|
<dl>
|
|
569
563
|
<dd>
|
|
570
564
|
|
|
571
|
-
**requestOptions:** `Sessions.RequestOptions`
|
|
572
|
-
|
|
565
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
566
|
+
|
|
573
567
|
</dd>
|
|
574
568
|
</dl>
|
|
575
569
|
</dd>
|
|
576
570
|
</dl>
|
|
577
571
|
|
|
572
|
+
|
|
578
573
|
</dd>
|
|
579
574
|
</dl>
|
|
580
575
|
</details>
|
|
581
576
|
|
|
582
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">updateSession</a>(
|
|
577
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">updateSession</a>({ ...params }) -> BrowserUse.SessionView</code></summary>
|
|
583
578
|
<dl>
|
|
584
579
|
<dd>
|
|
585
580
|
|
|
@@ -592,7 +587,6 @@ await client.sessions.getSession("session_id");
|
|
|
592
587
|
<dd>
|
|
593
588
|
|
|
594
589
|
Stop a session and all its running tasks.
|
|
595
|
-
|
|
596
590
|
</dd>
|
|
597
591
|
</dl>
|
|
598
592
|
</dd>
|
|
@@ -607,9 +601,11 @@ Stop a session and all its running tasks.
|
|
|
607
601
|
<dd>
|
|
608
602
|
|
|
609
603
|
```typescript
|
|
610
|
-
await client.sessions.updateSession(
|
|
611
|
-
|
|
604
|
+
await client.sessions.updateSession({
|
|
605
|
+
session_id: "session_id"
|
|
606
|
+
});
|
|
612
607
|
|
|
608
|
+
```
|
|
613
609
|
</dd>
|
|
614
610
|
</dl>
|
|
615
611
|
</dd>
|
|
@@ -623,34 +619,27 @@ await client.sessions.updateSession("session_id", {});
|
|
|
623
619
|
<dl>
|
|
624
620
|
<dd>
|
|
625
621
|
|
|
626
|
-
**
|
|
627
|
-
|
|
628
|
-
</dd>
|
|
629
|
-
</dl>
|
|
630
|
-
|
|
631
|
-
<dl>
|
|
632
|
-
<dd>
|
|
633
|
-
|
|
634
|
-
**request:** `BrowserUse.UpdateSessionRequest`
|
|
635
|
-
|
|
622
|
+
**request:** `BrowserUse.UpdateSessionRequest`
|
|
623
|
+
|
|
636
624
|
</dd>
|
|
637
625
|
</dl>
|
|
638
626
|
|
|
639
627
|
<dl>
|
|
640
628
|
<dd>
|
|
641
629
|
|
|
642
|
-
**requestOptions:** `Sessions.RequestOptions`
|
|
643
|
-
|
|
630
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
631
|
+
|
|
644
632
|
</dd>
|
|
645
633
|
</dl>
|
|
646
634
|
</dd>
|
|
647
635
|
</dl>
|
|
648
636
|
|
|
637
|
+
|
|
649
638
|
</dd>
|
|
650
639
|
</dl>
|
|
651
640
|
</details>
|
|
652
641
|
|
|
653
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getSessionPublicShare</a>(
|
|
642
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getSessionPublicShare</a>({ ...params }) -> BrowserUse.ShareView</code></summary>
|
|
654
643
|
<dl>
|
|
655
644
|
<dd>
|
|
656
645
|
|
|
@@ -663,7 +652,6 @@ await client.sessions.updateSession("session_id", {});
|
|
|
663
652
|
<dd>
|
|
664
653
|
|
|
665
654
|
Get public share information including URL and usage statistics.
|
|
666
|
-
|
|
667
655
|
</dd>
|
|
668
656
|
</dl>
|
|
669
657
|
</dd>
|
|
@@ -678,9 +666,11 @@ Get public share information including URL and usage statistics.
|
|
|
678
666
|
<dd>
|
|
679
667
|
|
|
680
668
|
```typescript
|
|
681
|
-
await client.sessions.getSessionPublicShare(
|
|
682
|
-
|
|
669
|
+
await client.sessions.getSessionPublicShare({
|
|
670
|
+
session_id: "session_id"
|
|
671
|
+
});
|
|
683
672
|
|
|
673
|
+
```
|
|
684
674
|
</dd>
|
|
685
675
|
</dl>
|
|
686
676
|
</dd>
|
|
@@ -694,26 +684,27 @@ await client.sessions.getSessionPublicShare("session_id");
|
|
|
694
684
|
<dl>
|
|
695
685
|
<dd>
|
|
696
686
|
|
|
697
|
-
**
|
|
698
|
-
|
|
687
|
+
**request:** `BrowserUse.GetSessionPublicShareSessionsSessionIdPublicShareGetRequest`
|
|
688
|
+
|
|
699
689
|
</dd>
|
|
700
690
|
</dl>
|
|
701
691
|
|
|
702
692
|
<dl>
|
|
703
693
|
<dd>
|
|
704
694
|
|
|
705
|
-
**requestOptions:** `Sessions.RequestOptions`
|
|
706
|
-
|
|
695
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
696
|
+
|
|
707
697
|
</dd>
|
|
708
698
|
</dl>
|
|
709
699
|
</dd>
|
|
710
700
|
</dl>
|
|
711
701
|
|
|
702
|
+
|
|
712
703
|
</dd>
|
|
713
704
|
</dl>
|
|
714
705
|
</details>
|
|
715
706
|
|
|
716
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">createSessionPublicShare</a>(
|
|
707
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">createSessionPublicShare</a>({ ...params }) -> BrowserUse.ShareView</code></summary>
|
|
717
708
|
<dl>
|
|
718
709
|
<dd>
|
|
719
710
|
|
|
@@ -726,7 +717,6 @@ await client.sessions.getSessionPublicShare("session_id");
|
|
|
726
717
|
<dd>
|
|
727
718
|
|
|
728
719
|
Create or return existing public share for a session.
|
|
729
|
-
|
|
730
720
|
</dd>
|
|
731
721
|
</dl>
|
|
732
722
|
</dd>
|
|
@@ -741,9 +731,11 @@ Create or return existing public share for a session.
|
|
|
741
731
|
<dd>
|
|
742
732
|
|
|
743
733
|
```typescript
|
|
744
|
-
await client.sessions.createSessionPublicShare(
|
|
745
|
-
|
|
734
|
+
await client.sessions.createSessionPublicShare({
|
|
735
|
+
session_id: "session_id"
|
|
736
|
+
});
|
|
746
737
|
|
|
738
|
+
```
|
|
747
739
|
</dd>
|
|
748
740
|
</dl>
|
|
749
741
|
</dd>
|
|
@@ -757,26 +749,27 @@ await client.sessions.createSessionPublicShare("session_id");
|
|
|
757
749
|
<dl>
|
|
758
750
|
<dd>
|
|
759
751
|
|
|
760
|
-
**
|
|
761
|
-
|
|
752
|
+
**request:** `BrowserUse.CreateSessionPublicShareSessionsSessionIdPublicSharePostRequest`
|
|
753
|
+
|
|
762
754
|
</dd>
|
|
763
755
|
</dl>
|
|
764
756
|
|
|
765
757
|
<dl>
|
|
766
758
|
<dd>
|
|
767
759
|
|
|
768
|
-
**requestOptions:** `Sessions.RequestOptions`
|
|
769
|
-
|
|
760
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
761
|
+
|
|
770
762
|
</dd>
|
|
771
763
|
</dl>
|
|
772
764
|
</dd>
|
|
773
765
|
</dl>
|
|
774
766
|
|
|
767
|
+
|
|
775
768
|
</dd>
|
|
776
769
|
</dl>
|
|
777
770
|
</details>
|
|
778
771
|
|
|
779
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">deleteSessionPublicShare</a>(
|
|
772
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">deleteSessionPublicShare</a>({ ...params }) -> void</code></summary>
|
|
780
773
|
<dl>
|
|
781
774
|
<dd>
|
|
782
775
|
|
|
@@ -789,7 +782,6 @@ await client.sessions.createSessionPublicShare("session_id");
|
|
|
789
782
|
<dd>
|
|
790
783
|
|
|
791
784
|
Remove public share for a session.
|
|
792
|
-
|
|
793
785
|
</dd>
|
|
794
786
|
</dl>
|
|
795
787
|
</dd>
|
|
@@ -804,9 +796,11 @@ Remove public share for a session.
|
|
|
804
796
|
<dd>
|
|
805
797
|
|
|
806
798
|
```typescript
|
|
807
|
-
await client.sessions.deleteSessionPublicShare(
|
|
808
|
-
|
|
799
|
+
await client.sessions.deleteSessionPublicShare({
|
|
800
|
+
session_id: "session_id"
|
|
801
|
+
});
|
|
809
802
|
|
|
803
|
+
```
|
|
810
804
|
</dd>
|
|
811
805
|
</dl>
|
|
812
806
|
</dd>
|
|
@@ -820,28 +814,28 @@ await client.sessions.deleteSessionPublicShare("session_id");
|
|
|
820
814
|
<dl>
|
|
821
815
|
<dd>
|
|
822
816
|
|
|
823
|
-
**
|
|
824
|
-
|
|
817
|
+
**request:** `BrowserUse.DeleteSessionPublicShareSessionsSessionIdPublicShareDeleteRequest`
|
|
818
|
+
|
|
825
819
|
</dd>
|
|
826
820
|
</dl>
|
|
827
821
|
|
|
828
822
|
<dl>
|
|
829
823
|
<dd>
|
|
830
824
|
|
|
831
|
-
**requestOptions:** `Sessions.RequestOptions`
|
|
832
|
-
|
|
825
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
826
|
+
|
|
833
827
|
</dd>
|
|
834
828
|
</dl>
|
|
835
829
|
</dd>
|
|
836
830
|
</dl>
|
|
837
831
|
|
|
832
|
+
|
|
838
833
|
</dd>
|
|
839
834
|
</dl>
|
|
840
835
|
</details>
|
|
841
836
|
|
|
842
837
|
## Files
|
|
843
|
-
|
|
844
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">userUploadFilePresignedUrl</a>(sessionId, { ...params }) -> BrowserUse.UploadFilePresignedUrlResponse</code></summary>
|
|
838
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">agentSessionUploadFilePresignedUrl</a>({ ...params }) -> BrowserUse.UploadFilePresignedUrlResponse</code></summary>
|
|
845
839
|
<dl>
|
|
846
840
|
<dd>
|
|
847
841
|
|
|
@@ -853,8 +847,7 @@ await client.sessions.deleteSessionPublicShare("session_id");
|
|
|
853
847
|
<dl>
|
|
854
848
|
<dd>
|
|
855
849
|
|
|
856
|
-
Generate a secure presigned URL for uploading files
|
|
857
|
-
|
|
850
|
+
Generate a secure presigned URL for uploading files to an agent session.
|
|
858
851
|
</dd>
|
|
859
852
|
</dl>
|
|
860
853
|
</dd>
|
|
@@ -869,13 +862,16 @@ Generate a secure presigned URL for uploading files that AI agents can use durin
|
|
|
869
862
|
<dd>
|
|
870
863
|
|
|
871
864
|
```typescript
|
|
872
|
-
await client.files.
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
865
|
+
await client.files.agentSessionUploadFilePresignedUrl({
|
|
866
|
+
session_id: "session_id",
|
|
867
|
+
body: {
|
|
868
|
+
fileName: "fileName",
|
|
869
|
+
contentType: "image/jpg",
|
|
870
|
+
sizeBytes: 1
|
|
871
|
+
}
|
|
876
872
|
});
|
|
877
|
-
```
|
|
878
873
|
|
|
874
|
+
```
|
|
879
875
|
</dd>
|
|
880
876
|
</dl>
|
|
881
877
|
</dd>
|
|
@@ -889,38 +885,69 @@ await client.files.userUploadFilePresignedUrl("session_id", {
|
|
|
889
885
|
<dl>
|
|
890
886
|
<dd>
|
|
891
887
|
|
|
892
|
-
**
|
|
893
|
-
|
|
888
|
+
**request:** `BrowserUse.AgentSessionUploadFilePresignedUrlFilesSessionsSessionIdPresignedUrlPostRequest`
|
|
889
|
+
|
|
894
890
|
</dd>
|
|
895
891
|
</dl>
|
|
896
892
|
|
|
897
893
|
<dl>
|
|
898
894
|
<dd>
|
|
899
895
|
|
|
900
|
-
**
|
|
896
|
+
**requestOptions:** `Files.RequestOptions`
|
|
897
|
+
|
|
898
|
+
</dd>
|
|
899
|
+
</dl>
|
|
900
|
+
</dd>
|
|
901
|
+
</dl>
|
|
902
|
+
|
|
901
903
|
|
|
902
904
|
</dd>
|
|
903
905
|
</dl>
|
|
906
|
+
</details>
|
|
907
|
+
|
|
908
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">browserSessionUploadFilePresignedUrl</a>({ ...params }) -> BrowserUse.UploadFilePresignedUrlResponse</code></summary>
|
|
909
|
+
<dl>
|
|
910
|
+
<dd>
|
|
911
|
+
|
|
912
|
+
#### 📝 Description
|
|
904
913
|
|
|
905
914
|
<dl>
|
|
906
915
|
<dd>
|
|
907
916
|
|
|
908
|
-
|
|
917
|
+
<dl>
|
|
918
|
+
<dd>
|
|
909
919
|
|
|
920
|
+
Generate a secure presigned URL for uploading files to a browser session.
|
|
910
921
|
</dd>
|
|
911
922
|
</dl>
|
|
912
923
|
</dd>
|
|
913
924
|
</dl>
|
|
914
925
|
|
|
915
|
-
|
|
916
|
-
</dl>
|
|
917
|
-
</details>
|
|
926
|
+
#### 🔌 Usage
|
|
918
927
|
|
|
919
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">getTaskOutputFilePresignedUrl</a>(taskId, fileId) -> BrowserUse.TaskOutputFileResponse</code></summary>
|
|
920
928
|
<dl>
|
|
921
929
|
<dd>
|
|
922
930
|
|
|
923
|
-
|
|
931
|
+
<dl>
|
|
932
|
+
<dd>
|
|
933
|
+
|
|
934
|
+
```typescript
|
|
935
|
+
await client.files.browserSessionUploadFilePresignedUrl({
|
|
936
|
+
session_id: "session_id",
|
|
937
|
+
body: {
|
|
938
|
+
fileName: "fileName",
|
|
939
|
+
contentType: "image/jpg",
|
|
940
|
+
sizeBytes: 1
|
|
941
|
+
}
|
|
942
|
+
});
|
|
943
|
+
|
|
944
|
+
```
|
|
945
|
+
</dd>
|
|
946
|
+
</dl>
|
|
947
|
+
</dd>
|
|
948
|
+
</dl>
|
|
949
|
+
|
|
950
|
+
#### ⚙️ Parameters
|
|
924
951
|
|
|
925
952
|
<dl>
|
|
926
953
|
<dd>
|
|
@@ -928,31 +955,45 @@ await client.files.userUploadFilePresignedUrl("session_id", {
|
|
|
928
955
|
<dl>
|
|
929
956
|
<dd>
|
|
930
957
|
|
|
931
|
-
|
|
958
|
+
**request:** `BrowserUse.BrowserSessionUploadFilePresignedUrlFilesBrowsersSessionIdPresignedUrlPostRequest`
|
|
959
|
+
|
|
960
|
+
</dd>
|
|
961
|
+
</dl>
|
|
962
|
+
|
|
963
|
+
<dl>
|
|
964
|
+
<dd>
|
|
932
965
|
|
|
966
|
+
**requestOptions:** `Files.RequestOptions`
|
|
967
|
+
|
|
933
968
|
</dd>
|
|
934
969
|
</dl>
|
|
935
970
|
</dd>
|
|
936
971
|
</dl>
|
|
937
972
|
|
|
938
|
-
#### 🔌 Usage
|
|
939
973
|
|
|
974
|
+
</dd>
|
|
975
|
+
</dl>
|
|
976
|
+
</details>
|
|
977
|
+
|
|
978
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">getTaskOutputFilePresignedUrl</a>({ ...params }) -> BrowserUse.TaskOutputFileResponse</code></summary>
|
|
940
979
|
<dl>
|
|
941
980
|
<dd>
|
|
942
981
|
|
|
982
|
+
#### 📝 Description
|
|
983
|
+
|
|
943
984
|
<dl>
|
|
944
985
|
<dd>
|
|
945
986
|
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
```
|
|
987
|
+
<dl>
|
|
988
|
+
<dd>
|
|
949
989
|
|
|
990
|
+
Get secure download URL for an output file generated by the AI agent.
|
|
950
991
|
</dd>
|
|
951
992
|
</dl>
|
|
952
993
|
</dd>
|
|
953
994
|
</dl>
|
|
954
995
|
|
|
955
|
-
####
|
|
996
|
+
#### 🔌 Usage
|
|
956
997
|
|
|
957
998
|
<dl>
|
|
958
999
|
<dd>
|
|
@@ -960,35 +1001,47 @@ await client.files.getTaskOutputFilePresignedUrl("task_id", "file_id");
|
|
|
960
1001
|
<dl>
|
|
961
1002
|
<dd>
|
|
962
1003
|
|
|
963
|
-
|
|
1004
|
+
```typescript
|
|
1005
|
+
await client.files.getTaskOutputFilePresignedUrl({
|
|
1006
|
+
task_id: "task_id",
|
|
1007
|
+
file_id: "file_id"
|
|
1008
|
+
});
|
|
964
1009
|
|
|
1010
|
+
```
|
|
1011
|
+
</dd>
|
|
1012
|
+
</dl>
|
|
965
1013
|
</dd>
|
|
966
1014
|
</dl>
|
|
967
1015
|
|
|
1016
|
+
#### ⚙️ Parameters
|
|
1017
|
+
|
|
968
1018
|
<dl>
|
|
969
1019
|
<dd>
|
|
970
1020
|
|
|
971
|
-
|
|
1021
|
+
<dl>
|
|
1022
|
+
<dd>
|
|
972
1023
|
|
|
1024
|
+
**request:** `BrowserUse.GetTaskOutputFilePresignedUrlFilesTasksTaskIdOutputFilesFileIdGetRequest`
|
|
1025
|
+
|
|
973
1026
|
</dd>
|
|
974
1027
|
</dl>
|
|
975
1028
|
|
|
976
1029
|
<dl>
|
|
977
1030
|
<dd>
|
|
978
1031
|
|
|
979
|
-
**requestOptions:** `Files.RequestOptions`
|
|
980
|
-
|
|
1032
|
+
**requestOptions:** `Files.RequestOptions`
|
|
1033
|
+
|
|
981
1034
|
</dd>
|
|
982
1035
|
</dl>
|
|
983
1036
|
</dd>
|
|
984
1037
|
</dl>
|
|
985
1038
|
|
|
1039
|
+
|
|
986
1040
|
</dd>
|
|
987
1041
|
</dl>
|
|
988
1042
|
</details>
|
|
989
1043
|
|
|
990
1044
|
## Profiles
|
|
991
|
-
|
|
992
1045
|
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">listProfiles</a>({ ...params }) -> BrowserUse.ProfileListResponse</code></summary>
|
|
993
1046
|
<dl>
|
|
994
1047
|
<dd>
|
|
@@ -1002,7 +1055,6 @@ await client.files.getTaskOutputFilePresignedUrl("task_id", "file_id");
|
|
|
1002
1055
|
<dd>
|
|
1003
1056
|
|
|
1004
1057
|
Get paginated list of profiles.
|
|
1005
|
-
|
|
1006
1058
|
</dd>
|
|
1007
1059
|
</dl>
|
|
1008
1060
|
</dd>
|
|
@@ -1018,8 +1070,8 @@ Get paginated list of profiles.
|
|
|
1018
1070
|
|
|
1019
1071
|
```typescript
|
|
1020
1072
|
await client.profiles.listProfiles();
|
|
1021
|
-
```
|
|
1022
1073
|
|
|
1074
|
+
```
|
|
1023
1075
|
</dd>
|
|
1024
1076
|
</dl>
|
|
1025
1077
|
</dd>
|
|
@@ -1033,26 +1085,27 @@ await client.profiles.listProfiles();
|
|
|
1033
1085
|
<dl>
|
|
1034
1086
|
<dd>
|
|
1035
1087
|
|
|
1036
|
-
**request:** `BrowserUse.ListProfilesProfilesGetRequest`
|
|
1037
|
-
|
|
1088
|
+
**request:** `BrowserUse.ListProfilesProfilesGetRequest`
|
|
1089
|
+
|
|
1038
1090
|
</dd>
|
|
1039
1091
|
</dl>
|
|
1040
1092
|
|
|
1041
1093
|
<dl>
|
|
1042
1094
|
<dd>
|
|
1043
1095
|
|
|
1044
|
-
**requestOptions:** `Profiles.RequestOptions`
|
|
1045
|
-
|
|
1096
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
1097
|
+
|
|
1046
1098
|
</dd>
|
|
1047
1099
|
</dl>
|
|
1048
1100
|
</dd>
|
|
1049
1101
|
</dl>
|
|
1050
1102
|
|
|
1103
|
+
|
|
1051
1104
|
</dd>
|
|
1052
1105
|
</dl>
|
|
1053
1106
|
</details>
|
|
1054
1107
|
|
|
1055
|
-
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">createProfile</a>() -> BrowserUse.ProfileView</code></summary>
|
|
1108
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">createProfile</a>({ ...params }) -> BrowserUse.ProfileView</code></summary>
|
|
1056
1109
|
<dl>
|
|
1057
1110
|
<dd>
|
|
1058
1111
|
|
|
@@ -1070,7 +1123,6 @@ They are most commonly used to allow users to preserve the log-in state in the a
|
|
|
1070
1123
|
You'd normally create one profile per user and then use it for all their tasks.
|
|
1071
1124
|
|
|
1072
1125
|
You can create a new profile by calling this endpoint.
|
|
1073
|
-
|
|
1074
1126
|
</dd>
|
|
1075
1127
|
</dl>
|
|
1076
1128
|
</dd>
|
|
@@ -1086,8 +1138,8 @@ You can create a new profile by calling this endpoint.
|
|
|
1086
1138
|
|
|
1087
1139
|
```typescript
|
|
1088
1140
|
await client.profiles.createProfile();
|
|
1089
|
-
```
|
|
1090
1141
|
|
|
1142
|
+
```
|
|
1091
1143
|
</dd>
|
|
1092
1144
|
</dl>
|
|
1093
1145
|
</dd>
|
|
@@ -1101,18 +1153,27 @@ await client.profiles.createProfile();
|
|
|
1101
1153
|
<dl>
|
|
1102
1154
|
<dd>
|
|
1103
1155
|
|
|
1104
|
-
**
|
|
1156
|
+
**request:** `BrowserUse.ProfileCreateRequest`
|
|
1157
|
+
|
|
1158
|
+
</dd>
|
|
1159
|
+
</dl>
|
|
1160
|
+
|
|
1161
|
+
<dl>
|
|
1162
|
+
<dd>
|
|
1105
1163
|
|
|
1164
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
1165
|
+
|
|
1106
1166
|
</dd>
|
|
1107
1167
|
</dl>
|
|
1108
1168
|
</dd>
|
|
1109
1169
|
</dl>
|
|
1110
1170
|
|
|
1171
|
+
|
|
1111
1172
|
</dd>
|
|
1112
1173
|
</dl>
|
|
1113
1174
|
</details>
|
|
1114
1175
|
|
|
1115
|
-
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">getProfile</a>(
|
|
1176
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">getProfile</a>({ ...params }) -> BrowserUse.ProfileView</code></summary>
|
|
1116
1177
|
<dl>
|
|
1117
1178
|
<dd>
|
|
1118
1179
|
|
|
@@ -1125,7 +1186,6 @@ await client.profiles.createProfile();
|
|
|
1125
1186
|
<dd>
|
|
1126
1187
|
|
|
1127
1188
|
Get profile details.
|
|
1128
|
-
|
|
1129
1189
|
</dd>
|
|
1130
1190
|
</dl>
|
|
1131
1191
|
</dd>
|
|
@@ -1140,9 +1200,11 @@ Get profile details.
|
|
|
1140
1200
|
<dd>
|
|
1141
1201
|
|
|
1142
1202
|
```typescript
|
|
1143
|
-
await client.profiles.getProfile(
|
|
1144
|
-
|
|
1203
|
+
await client.profiles.getProfile({
|
|
1204
|
+
profile_id: "profile_id"
|
|
1205
|
+
});
|
|
1145
1206
|
|
|
1207
|
+
```
|
|
1146
1208
|
</dd>
|
|
1147
1209
|
</dl>
|
|
1148
1210
|
</dd>
|
|
@@ -1156,26 +1218,27 @@ await client.profiles.getProfile("profile_id");
|
|
|
1156
1218
|
<dl>
|
|
1157
1219
|
<dd>
|
|
1158
1220
|
|
|
1159
|
-
**
|
|
1160
|
-
|
|
1221
|
+
**request:** `BrowserUse.GetProfileProfilesProfileIdGetRequest`
|
|
1222
|
+
|
|
1161
1223
|
</dd>
|
|
1162
1224
|
</dl>
|
|
1163
1225
|
|
|
1164
1226
|
<dl>
|
|
1165
1227
|
<dd>
|
|
1166
1228
|
|
|
1167
|
-
**requestOptions:** `Profiles.RequestOptions`
|
|
1168
|
-
|
|
1229
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
1230
|
+
|
|
1169
1231
|
</dd>
|
|
1170
1232
|
</dl>
|
|
1171
1233
|
</dd>
|
|
1172
1234
|
</dl>
|
|
1173
1235
|
|
|
1236
|
+
|
|
1174
1237
|
</dd>
|
|
1175
1238
|
</dl>
|
|
1176
1239
|
</details>
|
|
1177
1240
|
|
|
1178
|
-
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">deleteBrowserProfile</a>(
|
|
1241
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">deleteBrowserProfile</a>({ ...params }) -> void</code></summary>
|
|
1179
1242
|
<dl>
|
|
1180
1243
|
<dd>
|
|
1181
1244
|
|
|
@@ -1188,7 +1251,6 @@ await client.profiles.getProfile("profile_id");
|
|
|
1188
1251
|
<dd>
|
|
1189
1252
|
|
|
1190
1253
|
Permanently delete a browser profile and its configuration.
|
|
1191
|
-
|
|
1192
1254
|
</dd>
|
|
1193
1255
|
</dl>
|
|
1194
1256
|
</dd>
|
|
@@ -1203,9 +1265,11 @@ Permanently delete a browser profile and its configuration.
|
|
|
1203
1265
|
<dd>
|
|
1204
1266
|
|
|
1205
1267
|
```typescript
|
|
1206
|
-
await client.profiles.deleteBrowserProfile(
|
|
1207
|
-
|
|
1268
|
+
await client.profiles.deleteBrowserProfile({
|
|
1269
|
+
profile_id: "profile_id"
|
|
1270
|
+
});
|
|
1208
1271
|
|
|
1272
|
+
```
|
|
1209
1273
|
</dd>
|
|
1210
1274
|
</dl>
|
|
1211
1275
|
</dd>
|
|
@@ -1219,21 +1283,1217 @@ await client.profiles.deleteBrowserProfile("profile_id");
|
|
|
1219
1283
|
<dl>
|
|
1220
1284
|
<dd>
|
|
1221
1285
|
|
|
1222
|
-
**
|
|
1286
|
+
**request:** `BrowserUse.DeleteBrowserProfileProfilesProfileIdDeleteRequest`
|
|
1287
|
+
|
|
1288
|
+
</dd>
|
|
1289
|
+
</dl>
|
|
1290
|
+
|
|
1291
|
+
<dl>
|
|
1292
|
+
<dd>
|
|
1293
|
+
|
|
1294
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
1295
|
+
|
|
1296
|
+
</dd>
|
|
1297
|
+
</dl>
|
|
1298
|
+
</dd>
|
|
1299
|
+
</dl>
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
</dd>
|
|
1303
|
+
</dl>
|
|
1304
|
+
</details>
|
|
1305
|
+
|
|
1306
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">updateProfile</a>({ ...params }) -> BrowserUse.ProfileView</code></summary>
|
|
1307
|
+
<dl>
|
|
1308
|
+
<dd>
|
|
1309
|
+
|
|
1310
|
+
#### 📝 Description
|
|
1311
|
+
|
|
1312
|
+
<dl>
|
|
1313
|
+
<dd>
|
|
1314
|
+
|
|
1315
|
+
<dl>
|
|
1316
|
+
<dd>
|
|
1317
|
+
|
|
1318
|
+
Update a browser profile's information.
|
|
1319
|
+
</dd>
|
|
1320
|
+
</dl>
|
|
1321
|
+
</dd>
|
|
1322
|
+
</dl>
|
|
1323
|
+
|
|
1324
|
+
#### 🔌 Usage
|
|
1325
|
+
|
|
1326
|
+
<dl>
|
|
1327
|
+
<dd>
|
|
1328
|
+
|
|
1329
|
+
<dl>
|
|
1330
|
+
<dd>
|
|
1331
|
+
|
|
1332
|
+
```typescript
|
|
1333
|
+
await client.profiles.updateProfile({
|
|
1334
|
+
profile_id: "profile_id"
|
|
1335
|
+
});
|
|
1223
1336
|
|
|
1337
|
+
```
|
|
1338
|
+
</dd>
|
|
1339
|
+
</dl>
|
|
1224
1340
|
</dd>
|
|
1225
1341
|
</dl>
|
|
1226
1342
|
|
|
1343
|
+
#### ⚙️ Parameters
|
|
1344
|
+
|
|
1345
|
+
<dl>
|
|
1346
|
+
<dd>
|
|
1347
|
+
|
|
1227
1348
|
<dl>
|
|
1228
1349
|
<dd>
|
|
1229
1350
|
|
|
1230
|
-
**
|
|
1351
|
+
**request:** `BrowserUse.ProfileUpdateRequest`
|
|
1352
|
+
|
|
1353
|
+
</dd>
|
|
1354
|
+
</dl>
|
|
1355
|
+
|
|
1356
|
+
<dl>
|
|
1357
|
+
<dd>
|
|
1231
1358
|
|
|
1359
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
1360
|
+
|
|
1232
1361
|
</dd>
|
|
1233
1362
|
</dl>
|
|
1234
1363
|
</dd>
|
|
1235
1364
|
</dl>
|
|
1236
1365
|
|
|
1366
|
+
|
|
1367
|
+
</dd>
|
|
1368
|
+
</dl>
|
|
1369
|
+
</details>
|
|
1370
|
+
|
|
1371
|
+
## Browsers
|
|
1372
|
+
<details><summary><code>client.browsers.<a href="/src/api/resources/browsers/client/Client.ts">listBrowserSessions</a>({ ...params }) -> BrowserUse.BrowserSessionListResponse</code></summary>
|
|
1373
|
+
<dl>
|
|
1374
|
+
<dd>
|
|
1375
|
+
|
|
1376
|
+
#### 📝 Description
|
|
1377
|
+
|
|
1378
|
+
<dl>
|
|
1379
|
+
<dd>
|
|
1380
|
+
|
|
1381
|
+
<dl>
|
|
1382
|
+
<dd>
|
|
1383
|
+
|
|
1384
|
+
Get paginated list of browser sessions with optional status filtering.
|
|
1385
|
+
</dd>
|
|
1386
|
+
</dl>
|
|
1387
|
+
</dd>
|
|
1388
|
+
</dl>
|
|
1389
|
+
|
|
1390
|
+
#### 🔌 Usage
|
|
1391
|
+
|
|
1392
|
+
<dl>
|
|
1393
|
+
<dd>
|
|
1394
|
+
|
|
1395
|
+
<dl>
|
|
1396
|
+
<dd>
|
|
1397
|
+
|
|
1398
|
+
```typescript
|
|
1399
|
+
await client.browsers.listBrowserSessions();
|
|
1400
|
+
|
|
1401
|
+
```
|
|
1402
|
+
</dd>
|
|
1403
|
+
</dl>
|
|
1404
|
+
</dd>
|
|
1405
|
+
</dl>
|
|
1406
|
+
|
|
1407
|
+
#### ⚙️ Parameters
|
|
1408
|
+
|
|
1409
|
+
<dl>
|
|
1410
|
+
<dd>
|
|
1411
|
+
|
|
1412
|
+
<dl>
|
|
1413
|
+
<dd>
|
|
1414
|
+
|
|
1415
|
+
**request:** `BrowserUse.ListBrowserSessionsBrowsersGetRequest`
|
|
1416
|
+
|
|
1417
|
+
</dd>
|
|
1418
|
+
</dl>
|
|
1419
|
+
|
|
1420
|
+
<dl>
|
|
1421
|
+
<dd>
|
|
1422
|
+
|
|
1423
|
+
**requestOptions:** `Browsers.RequestOptions`
|
|
1424
|
+
|
|
1425
|
+
</dd>
|
|
1426
|
+
</dl>
|
|
1427
|
+
</dd>
|
|
1428
|
+
</dl>
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
</dd>
|
|
1432
|
+
</dl>
|
|
1433
|
+
</details>
|
|
1434
|
+
|
|
1435
|
+
<details><summary><code>client.browsers.<a href="/src/api/resources/browsers/client/Client.ts">createBrowserSession</a>({ ...params }) -> BrowserUse.BrowserSessionItemView</code></summary>
|
|
1436
|
+
<dl>
|
|
1437
|
+
<dd>
|
|
1438
|
+
|
|
1439
|
+
#### 📝 Description
|
|
1440
|
+
|
|
1441
|
+
<dl>
|
|
1442
|
+
<dd>
|
|
1443
|
+
|
|
1444
|
+
<dl>
|
|
1445
|
+
<dd>
|
|
1446
|
+
|
|
1447
|
+
Create a new browser session.
|
|
1448
|
+
|
|
1449
|
+
**Pricing:** Browser sessions are charged at $0.05 per hour.
|
|
1450
|
+
The full hourly rate is charged upfront when the session starts.
|
|
1451
|
+
When you stop the session, any unused time is automatically refunded proportionally.
|
|
1452
|
+
|
|
1453
|
+
Billing is rounded to the nearest minute (minimum 1 minute).
|
|
1454
|
+
For example, if you stop a session after 30 minutes, you'll be refunded $0.025.
|
|
1455
|
+
|
|
1456
|
+
**Session Limits:**
|
|
1457
|
+
- Free users (without active subscription): Maximum 15 minutes per session
|
|
1458
|
+
- Paid subscribers: Up to 4 hours per session
|
|
1459
|
+
</dd>
|
|
1460
|
+
</dl>
|
|
1461
|
+
</dd>
|
|
1462
|
+
</dl>
|
|
1463
|
+
|
|
1464
|
+
#### 🔌 Usage
|
|
1465
|
+
|
|
1466
|
+
<dl>
|
|
1467
|
+
<dd>
|
|
1468
|
+
|
|
1469
|
+
<dl>
|
|
1470
|
+
<dd>
|
|
1471
|
+
|
|
1472
|
+
```typescript
|
|
1473
|
+
await client.browsers.createBrowserSession();
|
|
1474
|
+
|
|
1475
|
+
```
|
|
1476
|
+
</dd>
|
|
1477
|
+
</dl>
|
|
1478
|
+
</dd>
|
|
1479
|
+
</dl>
|
|
1480
|
+
|
|
1481
|
+
#### ⚙️ Parameters
|
|
1482
|
+
|
|
1483
|
+
<dl>
|
|
1484
|
+
<dd>
|
|
1485
|
+
|
|
1486
|
+
<dl>
|
|
1487
|
+
<dd>
|
|
1488
|
+
|
|
1489
|
+
**request:** `BrowserUse.CreateBrowserSessionRequest`
|
|
1490
|
+
|
|
1491
|
+
</dd>
|
|
1492
|
+
</dl>
|
|
1493
|
+
|
|
1494
|
+
<dl>
|
|
1495
|
+
<dd>
|
|
1496
|
+
|
|
1497
|
+
**requestOptions:** `Browsers.RequestOptions`
|
|
1498
|
+
|
|
1499
|
+
</dd>
|
|
1500
|
+
</dl>
|
|
1501
|
+
</dd>
|
|
1502
|
+
</dl>
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
</dd>
|
|
1506
|
+
</dl>
|
|
1507
|
+
</details>
|
|
1508
|
+
|
|
1509
|
+
<details><summary><code>client.browsers.<a href="/src/api/resources/browsers/client/Client.ts">getBrowserSession</a>({ ...params }) -> BrowserUse.BrowserSessionView</code></summary>
|
|
1510
|
+
<dl>
|
|
1511
|
+
<dd>
|
|
1512
|
+
|
|
1513
|
+
#### 📝 Description
|
|
1514
|
+
|
|
1515
|
+
<dl>
|
|
1516
|
+
<dd>
|
|
1517
|
+
|
|
1518
|
+
<dl>
|
|
1519
|
+
<dd>
|
|
1520
|
+
|
|
1521
|
+
Get detailed browser session information including status and URLs.
|
|
1522
|
+
</dd>
|
|
1523
|
+
</dl>
|
|
1524
|
+
</dd>
|
|
1525
|
+
</dl>
|
|
1526
|
+
|
|
1527
|
+
#### 🔌 Usage
|
|
1528
|
+
|
|
1529
|
+
<dl>
|
|
1530
|
+
<dd>
|
|
1531
|
+
|
|
1532
|
+
<dl>
|
|
1533
|
+
<dd>
|
|
1534
|
+
|
|
1535
|
+
```typescript
|
|
1536
|
+
await client.browsers.getBrowserSession({
|
|
1537
|
+
session_id: "session_id"
|
|
1538
|
+
});
|
|
1539
|
+
|
|
1540
|
+
```
|
|
1541
|
+
</dd>
|
|
1542
|
+
</dl>
|
|
1543
|
+
</dd>
|
|
1544
|
+
</dl>
|
|
1545
|
+
|
|
1546
|
+
#### ⚙️ Parameters
|
|
1547
|
+
|
|
1548
|
+
<dl>
|
|
1549
|
+
<dd>
|
|
1550
|
+
|
|
1551
|
+
<dl>
|
|
1552
|
+
<dd>
|
|
1553
|
+
|
|
1554
|
+
**request:** `BrowserUse.GetBrowserSessionBrowsersSessionIdGetRequest`
|
|
1555
|
+
|
|
1556
|
+
</dd>
|
|
1557
|
+
</dl>
|
|
1558
|
+
|
|
1559
|
+
<dl>
|
|
1560
|
+
<dd>
|
|
1561
|
+
|
|
1562
|
+
**requestOptions:** `Browsers.RequestOptions`
|
|
1563
|
+
|
|
1564
|
+
</dd>
|
|
1565
|
+
</dl>
|
|
1566
|
+
</dd>
|
|
1567
|
+
</dl>
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
</dd>
|
|
1571
|
+
</dl>
|
|
1572
|
+
</details>
|
|
1573
|
+
|
|
1574
|
+
<details><summary><code>client.browsers.<a href="/src/api/resources/browsers/client/Client.ts">updateBrowserSession</a>({ ...params }) -> BrowserUse.BrowserSessionView</code></summary>
|
|
1575
|
+
<dl>
|
|
1576
|
+
<dd>
|
|
1577
|
+
|
|
1578
|
+
#### 📝 Description
|
|
1579
|
+
|
|
1580
|
+
<dl>
|
|
1581
|
+
<dd>
|
|
1582
|
+
|
|
1583
|
+
<dl>
|
|
1584
|
+
<dd>
|
|
1585
|
+
|
|
1586
|
+
Stop a browser session.
|
|
1587
|
+
|
|
1588
|
+
**Refund:** When you stop a session, unused time is automatically refunded.
|
|
1589
|
+
If the session ran for less than 1 hour, you'll receive a proportional refund.
|
|
1590
|
+
Billing is ceil to the nearest minute (minimum 1 minute).
|
|
1591
|
+
</dd>
|
|
1592
|
+
</dl>
|
|
1593
|
+
</dd>
|
|
1594
|
+
</dl>
|
|
1595
|
+
|
|
1596
|
+
#### 🔌 Usage
|
|
1597
|
+
|
|
1598
|
+
<dl>
|
|
1599
|
+
<dd>
|
|
1600
|
+
|
|
1601
|
+
<dl>
|
|
1602
|
+
<dd>
|
|
1603
|
+
|
|
1604
|
+
```typescript
|
|
1605
|
+
await client.browsers.updateBrowserSession({
|
|
1606
|
+
session_id: "session_id"
|
|
1607
|
+
});
|
|
1608
|
+
|
|
1609
|
+
```
|
|
1610
|
+
</dd>
|
|
1611
|
+
</dl>
|
|
1612
|
+
</dd>
|
|
1613
|
+
</dl>
|
|
1614
|
+
|
|
1615
|
+
#### ⚙️ Parameters
|
|
1616
|
+
|
|
1617
|
+
<dl>
|
|
1618
|
+
<dd>
|
|
1619
|
+
|
|
1620
|
+
<dl>
|
|
1621
|
+
<dd>
|
|
1622
|
+
|
|
1623
|
+
**request:** `BrowserUse.UpdateBrowserSessionRequest`
|
|
1624
|
+
|
|
1625
|
+
</dd>
|
|
1626
|
+
</dl>
|
|
1627
|
+
|
|
1628
|
+
<dl>
|
|
1629
|
+
<dd>
|
|
1630
|
+
|
|
1631
|
+
**requestOptions:** `Browsers.RequestOptions`
|
|
1632
|
+
|
|
1633
|
+
</dd>
|
|
1634
|
+
</dl>
|
|
1635
|
+
</dd>
|
|
1636
|
+
</dl>
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
</dd>
|
|
1640
|
+
</dl>
|
|
1641
|
+
</details>
|
|
1642
|
+
|
|
1643
|
+
## Workflows
|
|
1644
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">listWorkflows</a>({ ...params }) -> BrowserUse.WorkflowListResponse</code></summary>
|
|
1645
|
+
<dl>
|
|
1646
|
+
<dd>
|
|
1647
|
+
|
|
1648
|
+
#### 📝 Description
|
|
1649
|
+
|
|
1650
|
+
<dl>
|
|
1651
|
+
<dd>
|
|
1652
|
+
|
|
1653
|
+
<dl>
|
|
1654
|
+
<dd>
|
|
1655
|
+
|
|
1656
|
+
Get paginated list of workflows with optional filtering.
|
|
1657
|
+
</dd>
|
|
1658
|
+
</dl>
|
|
1659
|
+
</dd>
|
|
1660
|
+
</dl>
|
|
1661
|
+
|
|
1662
|
+
#### 🔌 Usage
|
|
1663
|
+
|
|
1664
|
+
<dl>
|
|
1665
|
+
<dd>
|
|
1666
|
+
|
|
1667
|
+
<dl>
|
|
1668
|
+
<dd>
|
|
1669
|
+
|
|
1670
|
+
```typescript
|
|
1671
|
+
await client.workflows.listWorkflows();
|
|
1672
|
+
|
|
1673
|
+
```
|
|
1674
|
+
</dd>
|
|
1675
|
+
</dl>
|
|
1676
|
+
</dd>
|
|
1677
|
+
</dl>
|
|
1678
|
+
|
|
1679
|
+
#### ⚙️ Parameters
|
|
1680
|
+
|
|
1681
|
+
<dl>
|
|
1682
|
+
<dd>
|
|
1683
|
+
|
|
1684
|
+
<dl>
|
|
1685
|
+
<dd>
|
|
1686
|
+
|
|
1687
|
+
**request:** `BrowserUse.ListWorkflowsWorkflowsGetRequest`
|
|
1688
|
+
|
|
1689
|
+
</dd>
|
|
1690
|
+
</dl>
|
|
1691
|
+
|
|
1692
|
+
<dl>
|
|
1693
|
+
<dd>
|
|
1694
|
+
|
|
1695
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
1696
|
+
|
|
1697
|
+
</dd>
|
|
1698
|
+
</dl>
|
|
1699
|
+
</dd>
|
|
1700
|
+
</dl>
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
</dd>
|
|
1704
|
+
</dl>
|
|
1705
|
+
</details>
|
|
1706
|
+
|
|
1707
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">createWorkflow</a>({ ...params }) -> BrowserUse.WorkflowResponse</code></summary>
|
|
1708
|
+
<dl>
|
|
1709
|
+
<dd>
|
|
1710
|
+
|
|
1711
|
+
#### 📝 Description
|
|
1712
|
+
|
|
1713
|
+
<dl>
|
|
1714
|
+
<dd>
|
|
1715
|
+
|
|
1716
|
+
<dl>
|
|
1717
|
+
<dd>
|
|
1718
|
+
|
|
1719
|
+
Create a new workflow. The workflow YAML should be uploaded separately via the update endpoint.
|
|
1720
|
+
</dd>
|
|
1721
|
+
</dl>
|
|
1722
|
+
</dd>
|
|
1723
|
+
</dl>
|
|
1724
|
+
|
|
1725
|
+
#### 🔌 Usage
|
|
1726
|
+
|
|
1727
|
+
<dl>
|
|
1728
|
+
<dd>
|
|
1729
|
+
|
|
1730
|
+
<dl>
|
|
1731
|
+
<dd>
|
|
1732
|
+
|
|
1733
|
+
```typescript
|
|
1734
|
+
await client.workflows.createWorkflow({
|
|
1735
|
+
name: "name"
|
|
1736
|
+
});
|
|
1737
|
+
|
|
1738
|
+
```
|
|
1739
|
+
</dd>
|
|
1740
|
+
</dl>
|
|
1741
|
+
</dd>
|
|
1742
|
+
</dl>
|
|
1743
|
+
|
|
1744
|
+
#### ⚙️ Parameters
|
|
1745
|
+
|
|
1746
|
+
<dl>
|
|
1747
|
+
<dd>
|
|
1748
|
+
|
|
1749
|
+
<dl>
|
|
1750
|
+
<dd>
|
|
1751
|
+
|
|
1752
|
+
**request:** `BrowserUse.WorkflowCreateRequest`
|
|
1753
|
+
|
|
1754
|
+
</dd>
|
|
1755
|
+
</dl>
|
|
1756
|
+
|
|
1757
|
+
<dl>
|
|
1758
|
+
<dd>
|
|
1759
|
+
|
|
1760
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
1761
|
+
|
|
1762
|
+
</dd>
|
|
1763
|
+
</dl>
|
|
1764
|
+
</dd>
|
|
1765
|
+
</dl>
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
</dd>
|
|
1769
|
+
</dl>
|
|
1770
|
+
</details>
|
|
1771
|
+
|
|
1772
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getWorkflow</a>({ ...params }) -> BrowserUse.WorkflowResponse</code></summary>
|
|
1773
|
+
<dl>
|
|
1774
|
+
<dd>
|
|
1775
|
+
|
|
1776
|
+
#### 📝 Description
|
|
1777
|
+
|
|
1778
|
+
<dl>
|
|
1779
|
+
<dd>
|
|
1780
|
+
|
|
1781
|
+
<dl>
|
|
1782
|
+
<dd>
|
|
1783
|
+
|
|
1784
|
+
Get detailed workflow information including presigned URL to download YAML.
|
|
1785
|
+
</dd>
|
|
1786
|
+
</dl>
|
|
1787
|
+
</dd>
|
|
1788
|
+
</dl>
|
|
1789
|
+
|
|
1790
|
+
#### 🔌 Usage
|
|
1791
|
+
|
|
1792
|
+
<dl>
|
|
1793
|
+
<dd>
|
|
1794
|
+
|
|
1795
|
+
<dl>
|
|
1796
|
+
<dd>
|
|
1797
|
+
|
|
1798
|
+
```typescript
|
|
1799
|
+
await client.workflows.getWorkflow({
|
|
1800
|
+
workflow_id: "workflow_id"
|
|
1801
|
+
});
|
|
1802
|
+
|
|
1803
|
+
```
|
|
1804
|
+
</dd>
|
|
1805
|
+
</dl>
|
|
1806
|
+
</dd>
|
|
1807
|
+
</dl>
|
|
1808
|
+
|
|
1809
|
+
#### ⚙️ Parameters
|
|
1810
|
+
|
|
1811
|
+
<dl>
|
|
1812
|
+
<dd>
|
|
1813
|
+
|
|
1814
|
+
<dl>
|
|
1815
|
+
<dd>
|
|
1816
|
+
|
|
1817
|
+
**request:** `BrowserUse.GetWorkflowWorkflowsWorkflowIdGetRequest`
|
|
1818
|
+
|
|
1819
|
+
</dd>
|
|
1820
|
+
</dl>
|
|
1821
|
+
|
|
1822
|
+
<dl>
|
|
1823
|
+
<dd>
|
|
1824
|
+
|
|
1825
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
1826
|
+
|
|
1827
|
+
</dd>
|
|
1828
|
+
</dl>
|
|
1829
|
+
</dd>
|
|
1830
|
+
</dl>
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
</dd>
|
|
1834
|
+
</dl>
|
|
1835
|
+
</details>
|
|
1836
|
+
|
|
1837
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">deleteWorkflow</a>({ ...params }) -> BrowserUse.WorkflowResponse</code></summary>
|
|
1838
|
+
<dl>
|
|
1839
|
+
<dd>
|
|
1840
|
+
|
|
1841
|
+
#### 📝 Description
|
|
1842
|
+
|
|
1843
|
+
<dl>
|
|
1844
|
+
<dd>
|
|
1845
|
+
|
|
1846
|
+
<dl>
|
|
1847
|
+
<dd>
|
|
1848
|
+
|
|
1849
|
+
Archive a workflow (soft delete).
|
|
1850
|
+
</dd>
|
|
1851
|
+
</dl>
|
|
1852
|
+
</dd>
|
|
1853
|
+
</dl>
|
|
1854
|
+
|
|
1855
|
+
#### 🔌 Usage
|
|
1856
|
+
|
|
1857
|
+
<dl>
|
|
1858
|
+
<dd>
|
|
1859
|
+
|
|
1860
|
+
<dl>
|
|
1861
|
+
<dd>
|
|
1862
|
+
|
|
1863
|
+
```typescript
|
|
1864
|
+
await client.workflows.deleteWorkflow({
|
|
1865
|
+
workflow_id: "workflow_id"
|
|
1866
|
+
});
|
|
1867
|
+
|
|
1868
|
+
```
|
|
1869
|
+
</dd>
|
|
1870
|
+
</dl>
|
|
1871
|
+
</dd>
|
|
1872
|
+
</dl>
|
|
1873
|
+
|
|
1874
|
+
#### ⚙️ Parameters
|
|
1875
|
+
|
|
1876
|
+
<dl>
|
|
1877
|
+
<dd>
|
|
1878
|
+
|
|
1879
|
+
<dl>
|
|
1880
|
+
<dd>
|
|
1881
|
+
|
|
1882
|
+
**request:** `BrowserUse.DeleteWorkflowWorkflowsWorkflowIdDeleteRequest`
|
|
1883
|
+
|
|
1884
|
+
</dd>
|
|
1885
|
+
</dl>
|
|
1886
|
+
|
|
1887
|
+
<dl>
|
|
1888
|
+
<dd>
|
|
1889
|
+
|
|
1890
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
1891
|
+
|
|
1892
|
+
</dd>
|
|
1893
|
+
</dl>
|
|
1894
|
+
</dd>
|
|
1895
|
+
</dl>
|
|
1896
|
+
|
|
1897
|
+
|
|
1898
|
+
</dd>
|
|
1899
|
+
</dl>
|
|
1900
|
+
</details>
|
|
1901
|
+
|
|
1902
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">updateWorkflow</a>({ ...params }) -> BrowserUse.WorkflowResponse</code></summary>
|
|
1903
|
+
<dl>
|
|
1904
|
+
<dd>
|
|
1905
|
+
|
|
1906
|
+
#### 📝 Description
|
|
1907
|
+
|
|
1908
|
+
<dl>
|
|
1909
|
+
<dd>
|
|
1910
|
+
|
|
1911
|
+
<dl>
|
|
1912
|
+
<dd>
|
|
1913
|
+
|
|
1914
|
+
Update workflow metadata.
|
|
1915
|
+
</dd>
|
|
1916
|
+
</dl>
|
|
1917
|
+
</dd>
|
|
1918
|
+
</dl>
|
|
1919
|
+
|
|
1920
|
+
#### 🔌 Usage
|
|
1921
|
+
|
|
1922
|
+
<dl>
|
|
1923
|
+
<dd>
|
|
1924
|
+
|
|
1925
|
+
<dl>
|
|
1926
|
+
<dd>
|
|
1927
|
+
|
|
1928
|
+
```typescript
|
|
1929
|
+
await client.workflows.updateWorkflow({
|
|
1930
|
+
workflow_id: "workflow_id"
|
|
1931
|
+
});
|
|
1932
|
+
|
|
1933
|
+
```
|
|
1934
|
+
</dd>
|
|
1935
|
+
</dl>
|
|
1936
|
+
</dd>
|
|
1937
|
+
</dl>
|
|
1938
|
+
|
|
1939
|
+
#### ⚙️ Parameters
|
|
1940
|
+
|
|
1941
|
+
<dl>
|
|
1942
|
+
<dd>
|
|
1943
|
+
|
|
1944
|
+
<dl>
|
|
1945
|
+
<dd>
|
|
1946
|
+
|
|
1947
|
+
**request:** `BrowserUse.WorkflowUpdateRequest`
|
|
1948
|
+
|
|
1949
|
+
</dd>
|
|
1950
|
+
</dl>
|
|
1951
|
+
|
|
1952
|
+
<dl>
|
|
1953
|
+
<dd>
|
|
1954
|
+
|
|
1955
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
1956
|
+
|
|
1957
|
+
</dd>
|
|
1958
|
+
</dl>
|
|
1959
|
+
</dd>
|
|
1960
|
+
</dl>
|
|
1961
|
+
|
|
1962
|
+
|
|
1963
|
+
</dd>
|
|
1964
|
+
</dl>
|
|
1965
|
+
</details>
|
|
1966
|
+
|
|
1967
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getWorkflowYamlPresignedUrl</a>({ ...params }) -> BrowserUse.WorkflowYamlPresignedUploadResponse</code></summary>
|
|
1968
|
+
<dl>
|
|
1969
|
+
<dd>
|
|
1970
|
+
|
|
1971
|
+
#### 📝 Description
|
|
1972
|
+
|
|
1973
|
+
<dl>
|
|
1974
|
+
<dd>
|
|
1975
|
+
|
|
1976
|
+
<dl>
|
|
1977
|
+
<dd>
|
|
1978
|
+
|
|
1979
|
+
Get a presigned URL to upload workflow YAML directly to S3 from the browser.
|
|
1980
|
+
|
|
1981
|
+
This avoids sending the YAML content through the backend, reducing latency
|
|
1982
|
+
and avoiding KMS permission issues in local development.
|
|
1983
|
+
</dd>
|
|
1984
|
+
</dl>
|
|
1985
|
+
</dd>
|
|
1986
|
+
</dl>
|
|
1987
|
+
|
|
1988
|
+
#### 🔌 Usage
|
|
1989
|
+
|
|
1990
|
+
<dl>
|
|
1991
|
+
<dd>
|
|
1992
|
+
|
|
1993
|
+
<dl>
|
|
1994
|
+
<dd>
|
|
1995
|
+
|
|
1996
|
+
```typescript
|
|
1997
|
+
await client.workflows.getWorkflowYamlPresignedUrl({
|
|
1998
|
+
workflow_id: "workflow_id",
|
|
1999
|
+
sizeBytes: 1
|
|
2000
|
+
});
|
|
2001
|
+
|
|
2002
|
+
```
|
|
2003
|
+
</dd>
|
|
2004
|
+
</dl>
|
|
2005
|
+
</dd>
|
|
2006
|
+
</dl>
|
|
2007
|
+
|
|
2008
|
+
#### ⚙️ Parameters
|
|
2009
|
+
|
|
2010
|
+
<dl>
|
|
2011
|
+
<dd>
|
|
2012
|
+
|
|
2013
|
+
<dl>
|
|
2014
|
+
<dd>
|
|
2015
|
+
|
|
2016
|
+
**request:** `BrowserUse.WorkflowYamlPresignedUploadRequest`
|
|
2017
|
+
|
|
2018
|
+
</dd>
|
|
2019
|
+
</dl>
|
|
2020
|
+
|
|
2021
|
+
<dl>
|
|
2022
|
+
<dd>
|
|
2023
|
+
|
|
2024
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
2025
|
+
|
|
2026
|
+
</dd>
|
|
2027
|
+
</dl>
|
|
2028
|
+
</dd>
|
|
2029
|
+
</dl>
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
</dd>
|
|
2033
|
+
</dl>
|
|
2034
|
+
</details>
|
|
2035
|
+
|
|
2036
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">executeWorkflow</a>({ ...params }) -> BrowserUse.ExecuteWorkflowWorkflowsWorkflowIdExecutePostResponse</code></summary>
|
|
2037
|
+
<dl>
|
|
2038
|
+
<dd>
|
|
2039
|
+
|
|
2040
|
+
#### 📝 Description
|
|
2041
|
+
|
|
2042
|
+
<dl>
|
|
2043
|
+
<dd>
|
|
2044
|
+
|
|
2045
|
+
<dl>
|
|
2046
|
+
<dd>
|
|
2047
|
+
|
|
2048
|
+
Execute a workflow either synchronously or asynchronously.
|
|
2049
|
+
|
|
2050
|
+
- ASYNC mode: Returns execution ID immediately and processes in background via Lambda
|
|
2051
|
+
- SYNC mode: Waits for execution to complete and returns results inline (max 5 min timeout)
|
|
2052
|
+
</dd>
|
|
2053
|
+
</dl>
|
|
2054
|
+
</dd>
|
|
2055
|
+
</dl>
|
|
2056
|
+
|
|
2057
|
+
#### 🔌 Usage
|
|
2058
|
+
|
|
2059
|
+
<dl>
|
|
2060
|
+
<dd>
|
|
2061
|
+
|
|
2062
|
+
<dl>
|
|
2063
|
+
<dd>
|
|
2064
|
+
|
|
2065
|
+
```typescript
|
|
2066
|
+
await client.workflows.executeWorkflow({
|
|
2067
|
+
workflow_id: "workflow_id"
|
|
2068
|
+
});
|
|
2069
|
+
|
|
2070
|
+
```
|
|
2071
|
+
</dd>
|
|
2072
|
+
</dl>
|
|
2073
|
+
</dd>
|
|
2074
|
+
</dl>
|
|
2075
|
+
|
|
2076
|
+
#### ⚙️ Parameters
|
|
2077
|
+
|
|
2078
|
+
<dl>
|
|
2079
|
+
<dd>
|
|
2080
|
+
|
|
2081
|
+
<dl>
|
|
2082
|
+
<dd>
|
|
2083
|
+
|
|
2084
|
+
**request:** `BrowserUse.WorkflowExecuteRequest`
|
|
2085
|
+
|
|
2086
|
+
</dd>
|
|
2087
|
+
</dl>
|
|
2088
|
+
|
|
2089
|
+
<dl>
|
|
2090
|
+
<dd>
|
|
2091
|
+
|
|
2092
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
2093
|
+
|
|
2094
|
+
</dd>
|
|
2095
|
+
</dl>
|
|
2096
|
+
</dd>
|
|
2097
|
+
</dl>
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
</dd>
|
|
2101
|
+
</dl>
|
|
2102
|
+
</details>
|
|
2103
|
+
|
|
2104
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">generateWorkflow</a>({ ...params }) -> BrowserUse.WorkflowGenerateResponse</code></summary>
|
|
2105
|
+
<dl>
|
|
2106
|
+
<dd>
|
|
2107
|
+
|
|
2108
|
+
#### 📝 Description
|
|
2109
|
+
|
|
2110
|
+
<dl>
|
|
2111
|
+
<dd>
|
|
2112
|
+
|
|
2113
|
+
<dl>
|
|
2114
|
+
<dd>
|
|
2115
|
+
|
|
2116
|
+
Generate a workflow from a natural language task description.
|
|
2117
|
+
|
|
2118
|
+
This endpoint uses the workflow-use library's HealingService to:
|
|
2119
|
+
1. Record browser interactions for the task
|
|
2120
|
+
2. Convert interactions to a reusable workflow
|
|
2121
|
+
3. Extract variables for parameterization
|
|
2122
|
+
4. Save the generated YAML to S3
|
|
2123
|
+
|
|
2124
|
+
The generation happens asynchronously via the workflow_worker Lambda.
|
|
2125
|
+
</dd>
|
|
2126
|
+
</dl>
|
|
2127
|
+
</dd>
|
|
2128
|
+
</dl>
|
|
2129
|
+
|
|
2130
|
+
#### 🔌 Usage
|
|
2131
|
+
|
|
2132
|
+
<dl>
|
|
2133
|
+
<dd>
|
|
2134
|
+
|
|
2135
|
+
<dl>
|
|
2136
|
+
<dd>
|
|
2137
|
+
|
|
2138
|
+
```typescript
|
|
2139
|
+
await client.workflows.generateWorkflow({
|
|
2140
|
+
workflow_id: "workflow_id",
|
|
2141
|
+
taskPrompt: "Go to github.com and search for browser-use"
|
|
2142
|
+
});
|
|
2143
|
+
|
|
2144
|
+
```
|
|
2145
|
+
</dd>
|
|
2146
|
+
</dl>
|
|
2147
|
+
</dd>
|
|
2148
|
+
</dl>
|
|
2149
|
+
|
|
2150
|
+
#### ⚙️ Parameters
|
|
2151
|
+
|
|
2152
|
+
<dl>
|
|
2153
|
+
<dd>
|
|
2154
|
+
|
|
2155
|
+
<dl>
|
|
2156
|
+
<dd>
|
|
2157
|
+
|
|
2158
|
+
**request:** `BrowserUse.WorkflowGenerateRequest`
|
|
2159
|
+
|
|
2160
|
+
</dd>
|
|
2161
|
+
</dl>
|
|
2162
|
+
|
|
2163
|
+
<dl>
|
|
2164
|
+
<dd>
|
|
2165
|
+
|
|
2166
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
2167
|
+
|
|
2168
|
+
</dd>
|
|
2169
|
+
</dl>
|
|
2170
|
+
</dd>
|
|
2171
|
+
</dl>
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
</dd>
|
|
2175
|
+
</dl>
|
|
2176
|
+
</details>
|
|
2177
|
+
|
|
2178
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getExecution</a>({ ...params }) -> BrowserUse.WorkflowExecutionResponse</code></summary>
|
|
2179
|
+
<dl>
|
|
2180
|
+
<dd>
|
|
2181
|
+
|
|
2182
|
+
#### 📝 Description
|
|
2183
|
+
|
|
2184
|
+
<dl>
|
|
2185
|
+
<dd>
|
|
2186
|
+
|
|
2187
|
+
<dl>
|
|
2188
|
+
<dd>
|
|
2189
|
+
|
|
2190
|
+
Get detailed execution information including status, results, and costs.
|
|
2191
|
+
</dd>
|
|
2192
|
+
</dl>
|
|
2193
|
+
</dd>
|
|
2194
|
+
</dl>
|
|
2195
|
+
|
|
2196
|
+
#### 🔌 Usage
|
|
2197
|
+
|
|
2198
|
+
<dl>
|
|
2199
|
+
<dd>
|
|
2200
|
+
|
|
2201
|
+
<dl>
|
|
2202
|
+
<dd>
|
|
2203
|
+
|
|
2204
|
+
```typescript
|
|
2205
|
+
await client.workflows.getExecution({
|
|
2206
|
+
execution_id: "execution_id"
|
|
2207
|
+
});
|
|
2208
|
+
|
|
2209
|
+
```
|
|
2210
|
+
</dd>
|
|
2211
|
+
</dl>
|
|
2212
|
+
</dd>
|
|
2213
|
+
</dl>
|
|
2214
|
+
|
|
2215
|
+
#### ⚙️ Parameters
|
|
2216
|
+
|
|
2217
|
+
<dl>
|
|
2218
|
+
<dd>
|
|
2219
|
+
|
|
2220
|
+
<dl>
|
|
2221
|
+
<dd>
|
|
2222
|
+
|
|
2223
|
+
**request:** `BrowserUse.GetExecutionWorkflowsExecutionsExecutionIdGetRequest`
|
|
2224
|
+
|
|
2225
|
+
</dd>
|
|
2226
|
+
</dl>
|
|
2227
|
+
|
|
2228
|
+
<dl>
|
|
2229
|
+
<dd>
|
|
2230
|
+
|
|
2231
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
2232
|
+
|
|
2233
|
+
</dd>
|
|
2234
|
+
</dl>
|
|
2235
|
+
</dd>
|
|
2236
|
+
</dl>
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
</dd>
|
|
2240
|
+
</dl>
|
|
2241
|
+
</details>
|
|
2242
|
+
|
|
2243
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">listWorkflowExecutions</a>({ ...params }) -> BrowserUse.WorkflowExecutionListResponse</code></summary>
|
|
2244
|
+
<dl>
|
|
2245
|
+
<dd>
|
|
2246
|
+
|
|
2247
|
+
#### 📝 Description
|
|
2248
|
+
|
|
2249
|
+
<dl>
|
|
2250
|
+
<dd>
|
|
2251
|
+
|
|
2252
|
+
<dl>
|
|
2253
|
+
<dd>
|
|
2254
|
+
|
|
2255
|
+
Get paginated list of executions for a specific workflow.
|
|
2256
|
+
</dd>
|
|
2257
|
+
</dl>
|
|
2258
|
+
</dd>
|
|
2259
|
+
</dl>
|
|
2260
|
+
|
|
2261
|
+
#### 🔌 Usage
|
|
2262
|
+
|
|
2263
|
+
<dl>
|
|
2264
|
+
<dd>
|
|
2265
|
+
|
|
2266
|
+
<dl>
|
|
2267
|
+
<dd>
|
|
2268
|
+
|
|
2269
|
+
```typescript
|
|
2270
|
+
await client.workflows.listWorkflowExecutions({
|
|
2271
|
+
workflow_id: "workflow_id"
|
|
2272
|
+
});
|
|
2273
|
+
|
|
2274
|
+
```
|
|
2275
|
+
</dd>
|
|
2276
|
+
</dl>
|
|
2277
|
+
</dd>
|
|
2278
|
+
</dl>
|
|
2279
|
+
|
|
2280
|
+
#### ⚙️ Parameters
|
|
2281
|
+
|
|
2282
|
+
<dl>
|
|
2283
|
+
<dd>
|
|
2284
|
+
|
|
2285
|
+
<dl>
|
|
2286
|
+
<dd>
|
|
2287
|
+
|
|
2288
|
+
**request:** `BrowserUse.ListWorkflowExecutionsWorkflowsWorkflowIdExecutionsGetRequest`
|
|
2289
|
+
|
|
2290
|
+
</dd>
|
|
2291
|
+
</dl>
|
|
2292
|
+
|
|
2293
|
+
<dl>
|
|
2294
|
+
<dd>
|
|
2295
|
+
|
|
2296
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
2297
|
+
|
|
2298
|
+
</dd>
|
|
2299
|
+
</dl>
|
|
2300
|
+
</dd>
|
|
2301
|
+
</dl>
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
</dd>
|
|
2305
|
+
</dl>
|
|
2306
|
+
</details>
|
|
2307
|
+
|
|
2308
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">listAllExecutions</a>({ ...params }) -> BrowserUse.WorkflowExecutionListResponse</code></summary>
|
|
2309
|
+
<dl>
|
|
2310
|
+
<dd>
|
|
2311
|
+
|
|
2312
|
+
#### 📝 Description
|
|
2313
|
+
|
|
2314
|
+
<dl>
|
|
2315
|
+
<dd>
|
|
2316
|
+
|
|
2317
|
+
<dl>
|
|
2318
|
+
<dd>
|
|
2319
|
+
|
|
2320
|
+
Get paginated list of all workflow executions for a project.
|
|
2321
|
+
</dd>
|
|
2322
|
+
</dl>
|
|
2323
|
+
</dd>
|
|
2324
|
+
</dl>
|
|
2325
|
+
|
|
2326
|
+
#### 🔌 Usage
|
|
2327
|
+
|
|
2328
|
+
<dl>
|
|
2329
|
+
<dd>
|
|
2330
|
+
|
|
2331
|
+
<dl>
|
|
2332
|
+
<dd>
|
|
2333
|
+
|
|
2334
|
+
```typescript
|
|
2335
|
+
await client.workflows.listAllExecutions();
|
|
2336
|
+
|
|
2337
|
+
```
|
|
2338
|
+
</dd>
|
|
2339
|
+
</dl>
|
|
2340
|
+
</dd>
|
|
2341
|
+
</dl>
|
|
2342
|
+
|
|
2343
|
+
#### ⚙️ Parameters
|
|
2344
|
+
|
|
2345
|
+
<dl>
|
|
2346
|
+
<dd>
|
|
2347
|
+
|
|
2348
|
+
<dl>
|
|
2349
|
+
<dd>
|
|
2350
|
+
|
|
2351
|
+
**request:** `BrowserUse.ListAllExecutionsWorkflowsExecutionsGetRequest`
|
|
2352
|
+
|
|
2353
|
+
</dd>
|
|
2354
|
+
</dl>
|
|
2355
|
+
|
|
2356
|
+
<dl>
|
|
2357
|
+
<dd>
|
|
2358
|
+
|
|
2359
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
2360
|
+
|
|
2361
|
+
</dd>
|
|
2362
|
+
</dl>
|
|
2363
|
+
</dd>
|
|
2364
|
+
</dl>
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
</dd>
|
|
2368
|
+
</dl>
|
|
2369
|
+
</details>
|
|
2370
|
+
|
|
2371
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">cancelExecution</a>({ ...params }) -> BrowserUse.WorkflowExecutionResponse</code></summary>
|
|
2372
|
+
<dl>
|
|
2373
|
+
<dd>
|
|
2374
|
+
|
|
2375
|
+
#### 📝 Description
|
|
2376
|
+
|
|
2377
|
+
<dl>
|
|
2378
|
+
<dd>
|
|
2379
|
+
|
|
2380
|
+
<dl>
|
|
2381
|
+
<dd>
|
|
2382
|
+
|
|
2383
|
+
Cancel a pending or running workflow execution.
|
|
2384
|
+
</dd>
|
|
2385
|
+
</dl>
|
|
2386
|
+
</dd>
|
|
2387
|
+
</dl>
|
|
2388
|
+
|
|
2389
|
+
#### 🔌 Usage
|
|
2390
|
+
|
|
2391
|
+
<dl>
|
|
2392
|
+
<dd>
|
|
2393
|
+
|
|
2394
|
+
<dl>
|
|
2395
|
+
<dd>
|
|
2396
|
+
|
|
2397
|
+
```typescript
|
|
2398
|
+
await client.workflows.cancelExecution({
|
|
2399
|
+
execution_id: "execution_id"
|
|
2400
|
+
});
|
|
2401
|
+
|
|
2402
|
+
```
|
|
2403
|
+
</dd>
|
|
2404
|
+
</dl>
|
|
2405
|
+
</dd>
|
|
2406
|
+
</dl>
|
|
2407
|
+
|
|
2408
|
+
#### ⚙️ Parameters
|
|
2409
|
+
|
|
2410
|
+
<dl>
|
|
2411
|
+
<dd>
|
|
2412
|
+
|
|
2413
|
+
<dl>
|
|
2414
|
+
<dd>
|
|
2415
|
+
|
|
2416
|
+
**request:** `BrowserUse.CancelExecutionWorkflowsExecutionsExecutionIdCancelPatchRequest`
|
|
2417
|
+
|
|
2418
|
+
</dd>
|
|
2419
|
+
</dl>
|
|
2420
|
+
|
|
2421
|
+
<dl>
|
|
2422
|
+
<dd>
|
|
2423
|
+
|
|
2424
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
2425
|
+
|
|
2426
|
+
</dd>
|
|
2427
|
+
</dl>
|
|
2428
|
+
</dd>
|
|
2429
|
+
</dl>
|
|
2430
|
+
|
|
2431
|
+
|
|
2432
|
+
</dd>
|
|
2433
|
+
</dl>
|
|
2434
|
+
</details>
|
|
2435
|
+
|
|
2436
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getExecutionLogs</a>({ ...params }) -> BrowserUse.WorkflowExecutionLogResponse</code></summary>
|
|
2437
|
+
<dl>
|
|
2438
|
+
<dd>
|
|
2439
|
+
|
|
2440
|
+
#### 📝 Description
|
|
2441
|
+
|
|
2442
|
+
<dl>
|
|
2443
|
+
<dd>
|
|
2444
|
+
|
|
2445
|
+
<dl>
|
|
2446
|
+
<dd>
|
|
2447
|
+
|
|
2448
|
+
Get presigned URL to download execution logs.
|
|
2449
|
+
</dd>
|
|
2450
|
+
</dl>
|
|
2451
|
+
</dd>
|
|
2452
|
+
</dl>
|
|
2453
|
+
|
|
2454
|
+
#### 🔌 Usage
|
|
2455
|
+
|
|
2456
|
+
<dl>
|
|
2457
|
+
<dd>
|
|
2458
|
+
|
|
2459
|
+
<dl>
|
|
2460
|
+
<dd>
|
|
2461
|
+
|
|
2462
|
+
```typescript
|
|
2463
|
+
await client.workflows.getExecutionLogs({
|
|
2464
|
+
execution_id: "execution_id"
|
|
2465
|
+
});
|
|
2466
|
+
|
|
2467
|
+
```
|
|
2468
|
+
</dd>
|
|
2469
|
+
</dl>
|
|
2470
|
+
</dd>
|
|
2471
|
+
</dl>
|
|
2472
|
+
|
|
2473
|
+
#### ⚙️ Parameters
|
|
2474
|
+
|
|
2475
|
+
<dl>
|
|
2476
|
+
<dd>
|
|
2477
|
+
|
|
2478
|
+
<dl>
|
|
2479
|
+
<dd>
|
|
2480
|
+
|
|
2481
|
+
**request:** `BrowserUse.GetExecutionLogsWorkflowsExecutionsExecutionIdLogsGetRequest`
|
|
2482
|
+
|
|
2483
|
+
</dd>
|
|
2484
|
+
</dl>
|
|
2485
|
+
|
|
2486
|
+
<dl>
|
|
2487
|
+
<dd>
|
|
2488
|
+
|
|
2489
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
2490
|
+
|
|
2491
|
+
</dd>
|
|
2492
|
+
</dl>
|
|
2493
|
+
</dd>
|
|
2494
|
+
</dl>
|
|
2495
|
+
|
|
2496
|
+
|
|
1237
2497
|
</dd>
|
|
1238
2498
|
</dl>
|
|
1239
2499
|
</details>
|