browser-use-sdk 1.2.0 → 2.0.1
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/README.md +130 -317
- package/dist/cjs/Client.d.ts +46 -0
- package/dist/cjs/Client.js +79 -0
- package/dist/cjs/api/errors/BadRequestError.d.ts +8 -0
- package/dist/cjs/api/errors/BadRequestError.js +52 -0
- package/dist/cjs/api/errors/InternalServerError.d.ts +8 -0
- package/dist/cjs/api/errors/InternalServerError.js +52 -0
- package/dist/cjs/api/errors/NotFoundError.d.ts +8 -0
- package/dist/cjs/api/errors/NotFoundError.js +52 -0
- package/dist/cjs/api/errors/PaymentRequiredError.d.ts +9 -0
- package/dist/cjs/api/errors/PaymentRequiredError.js +52 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +8 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.js +52 -0
- package/dist/cjs/api/errors/index.d.ts +5 -0
- package/dist/cjs/api/errors/index.js +21 -0
- package/dist/cjs/api/index.d.ts +3 -0
- package/dist/cjs/api/index.js +19 -0
- package/dist/cjs/api/resources/accounts/client/Client.d.ts +47 -0
- package/dist/cjs/api/resources/accounts/client/Client.js +123 -0
- package/dist/cjs/api/resources/accounts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/accounts/client/index.js +2 -0
- package/dist/cjs/api/resources/accounts/index.d.ts +1 -0
- package/dist/cjs/api/resources/accounts/index.js +17 -0
- package/dist/cjs/api/resources/files/client/Client.d.ts +72 -0
- package/dist/cjs/api/resources/files/client/Client.js +210 -0
- package/dist/cjs/api/resources/files/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/files/client/index.js +17 -0
- package/dist/cjs/api/resources/files/client/requests/UploadFileRequest.d.ts +40 -0
- package/dist/cjs/api/resources/files/client/requests/UploadFileRequest.js +25 -0
- package/dist/cjs/api/resources/files/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/files/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/files/index.d.ts +1 -0
- package/dist/cjs/api/resources/files/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +9 -0
- package/dist/cjs/api/resources/index.js +48 -0
- package/dist/cjs/api/resources/profiles/client/Client.d.ts +93 -0
- package/dist/cjs/api/resources/profiles/client/Client.js +319 -0
- package/dist/cjs/api/resources/profiles/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/profiles/client/index.js +17 -0
- package/dist/cjs/api/resources/profiles/client/requests/ListProfilesProfilesGetRequest.d.ts +11 -0
- package/dist/cjs/api/resources/profiles/client/requests/ListProfilesProfilesGetRequest.js +5 -0
- package/dist/cjs/api/resources/profiles/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/profiles/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/profiles/index.d.ts +1 -0
- package/dist/cjs/api/resources/profiles/index.js +17 -0
- package/dist/cjs/api/resources/sessions/client/Client.d.ts +146 -0
- package/dist/cjs/api/resources/sessions/client/Client.js +573 -0
- package/dist/cjs/api/resources/sessions/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/sessions/client/index.js +17 -0
- package/dist/cjs/api/resources/sessions/client/requests/CreateSessionRequest.d.ts +14 -0
- package/dist/cjs/api/resources/sessions/client/requests/CreateSessionRequest.js +5 -0
- package/dist/cjs/api/resources/sessions/client/requests/ListSessionsSessionsGetRequest.d.ts +13 -0
- package/dist/cjs/api/resources/sessions/client/requests/ListSessionsSessionsGetRequest.js +5 -0
- package/dist/cjs/api/resources/sessions/client/requests/UpdateSessionRequest.d.ts +9 -0
- package/dist/cjs/api/resources/sessions/client/requests/UpdateSessionRequest.js +5 -0
- package/dist/cjs/api/resources/sessions/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/sessions/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/sessions/index.d.ts +1 -0
- package/dist/cjs/api/resources/sessions/index.js +17 -0
- package/dist/cjs/api/resources/tasks/client/Client.d.ts +113 -0
- package/dist/cjs/api/resources/tasks/client/Client.js +411 -0
- package/dist/cjs/api/resources/tasks/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/tasks/client/index.js +17 -0
- package/dist/cjs/api/resources/tasks/client/requests/CreateTaskRequest.d.ts +40 -0
- package/dist/cjs/api/resources/tasks/client/requests/CreateTaskRequest.js +5 -0
- package/dist/cjs/api/resources/tasks/client/requests/ListTasksTasksGetRequest.d.ts +16 -0
- package/dist/cjs/api/resources/tasks/client/requests/ListTasksTasksGetRequest.js +5 -0
- package/dist/cjs/api/resources/tasks/client/requests/UpdateTaskRequest.d.ts +14 -0
- package/dist/cjs/api/resources/tasks/client/requests/UpdateTaskRequest.js +5 -0
- package/dist/cjs/api/resources/tasks/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/tasks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tasks/index.d.ts +1 -0
- package/dist/cjs/api/resources/tasks/index.js +17 -0
- package/dist/cjs/api/types/AccountNotFoundError.d.ts +9 -0
- package/dist/cjs/api/types/AccountNotFoundError.js +5 -0
- package/dist/cjs/api/types/AccountView.d.ts +18 -0
- package/dist/cjs/api/types/AccountView.js +5 -0
- package/dist/cjs/api/types/BadRequestErrorBody.d.ts +5 -0
- package/dist/cjs/api/types/BadRequestErrorBody.js +5 -0
- package/dist/cjs/api/types/DownloadUrlGenerationError.d.ts +9 -0
- package/dist/cjs/api/types/DownloadUrlGenerationError.js +5 -0
- package/dist/cjs/api/types/FileView.d.ts +12 -0
- package/dist/cjs/api/types/FileView.js +5 -0
- package/dist/cjs/api/types/HttpValidationError.d.ts +7 -0
- package/dist/cjs/api/types/HttpValidationError.js +5 -0
- package/dist/cjs/api/types/InsufficientCreditsError.d.ts +9 -0
- package/dist/cjs/api/types/InsufficientCreditsError.js +5 -0
- package/dist/cjs/api/types/InternalServerErrorBody.d.ts +9 -0
- package/dist/cjs/api/types/InternalServerErrorBody.js +5 -0
- package/dist/cjs/api/types/NotFoundErrorBody.d.ts +5 -0
- package/dist/cjs/api/types/NotFoundErrorBody.js +5 -0
- package/dist/cjs/api/types/OutputFileNotFoundError.d.ts +9 -0
- package/dist/cjs/api/types/OutputFileNotFoundError.js +5 -0
- package/dist/cjs/api/types/ProfileListResponse.d.ts +17 -0
- package/dist/cjs/api/types/ProfileListResponse.js +5 -0
- package/dist/cjs/api/types/ProfileNotFoundError.d.ts +9 -0
- package/dist/cjs/api/types/ProfileNotFoundError.js +5 -0
- package/dist/cjs/api/types/ProfileView.d.ts +18 -0
- package/dist/cjs/api/types/ProfileView.js +5 -0
- package/dist/cjs/api/types/ProxyCountryCode.d.ts +16 -0
- package/dist/cjs/api/types/ProxyCountryCode.js +18 -0
- package/dist/cjs/api/types/SessionHasRunningTaskError.d.ts +9 -0
- package/dist/cjs/api/types/SessionHasRunningTaskError.js +5 -0
- package/dist/cjs/api/types/SessionItemView.d.ts +19 -0
- package/dist/cjs/api/types/SessionItemView.js +5 -0
- package/dist/cjs/api/types/SessionListResponse.d.ts +17 -0
- package/dist/cjs/api/types/SessionListResponse.js +5 -0
- package/dist/cjs/api/types/SessionNotFoundError.d.ts +9 -0
- package/dist/cjs/api/types/SessionNotFoundError.js +5 -0
- package/dist/cjs/api/types/SessionStatus.d.ts +15 -0
- package/dist/cjs/api/types/SessionStatus.js +10 -0
- package/dist/cjs/api/types/SessionStoppedError.d.ts +9 -0
- package/dist/cjs/api/types/SessionStoppedError.js +5 -0
- package/dist/cjs/api/types/SessionUpdateAction.d.ts +10 -0
- package/dist/cjs/api/types/SessionUpdateAction.js +5 -0
- package/dist/cjs/api/types/SessionView.d.ts +23 -0
- package/dist/cjs/api/types/SessionView.js +5 -0
- package/dist/cjs/api/types/ShareNotFoundError.d.ts +9 -0
- package/dist/cjs/api/types/ShareNotFoundError.js +5 -0
- package/dist/cjs/api/types/ShareView.d.ts +16 -0
- package/dist/cjs/api/types/ShareView.js +5 -0
- package/dist/cjs/api/types/SupportedLlMs.d.ts +17 -0
- package/dist/cjs/api/types/SupportedLlMs.js +19 -0
- package/dist/cjs/api/types/TaskCreatedResponse.d.ts +10 -0
- package/dist/cjs/api/types/TaskCreatedResponse.js +5 -0
- package/dist/cjs/api/types/TaskItemView.d.ts +32 -0
- package/dist/cjs/api/types/TaskItemView.js +5 -0
- package/dist/cjs/api/types/TaskListResponse.d.ts +17 -0
- package/dist/cjs/api/types/TaskListResponse.js +5 -0
- package/dist/cjs/api/types/TaskLogFileResponse.d.ts +10 -0
- package/dist/cjs/api/types/TaskLogFileResponse.js +5 -0
- package/dist/cjs/api/types/TaskNotFoundError.d.ts +9 -0
- package/dist/cjs/api/types/TaskNotFoundError.js +5 -0
- package/dist/cjs/api/types/TaskOutputFileResponse.d.ts +14 -0
- package/dist/cjs/api/types/TaskOutputFileResponse.js +5 -0
- package/dist/cjs/api/types/TaskStatus.d.ts +19 -0
- package/dist/cjs/api/types/TaskStatus.js +12 -0
- package/dist/cjs/api/types/TaskStepView.d.ts +22 -0
- package/dist/cjs/api/types/TaskStepView.js +5 -0
- package/dist/cjs/api/types/TaskUpdateAction.d.ts +19 -0
- package/dist/cjs/api/types/TaskUpdateAction.js +12 -0
- package/dist/cjs/api/types/TaskView.d.ts +34 -0
- package/dist/cjs/api/types/TaskView.js +5 -0
- package/dist/cjs/api/types/UnsupportedContentTypeError.d.ts +9 -0
- package/dist/cjs/api/types/UnsupportedContentTypeError.js +5 -0
- package/dist/cjs/api/types/UploadFilePresignedUrlResponse.d.ts +18 -0
- package/dist/cjs/api/types/UploadFilePresignedUrlResponse.js +5 -0
- package/dist/cjs/api/types/ValidationError.d.ts +14 -0
- package/dist/cjs/api/types/ValidationError.js +5 -0
- package/dist/cjs/api/types/index.d.ts +38 -0
- package/dist/cjs/api/types/index.js +54 -0
- package/dist/cjs/core/fetcher/APIResponse.d.ts +20 -0
- package/dist/cjs/core/fetcher/APIResponse.js +2 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +20 -0
- package/dist/cjs/core/fetcher/BinaryResponse.js +17 -0
- package/dist/cjs/core/fetcher/Fetcher.d.ts +40 -0
- package/dist/cjs/core/fetcher/Fetcher.js +120 -0
- package/dist/cjs/core/fetcher/Headers.d.ts +2 -0
- package/dist/cjs/core/fetcher/Headers.js +84 -0
- package/dist/cjs/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/cjs/core/fetcher/HttpResponsePromise.js +103 -0
- package/dist/cjs/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/cjs/core/fetcher/RawResponse.js +44 -0
- package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +4 -0
- package/dist/cjs/core/fetcher/ResponseWithBody.js +6 -0
- package/dist/cjs/core/fetcher/Supplier.d.ts +4 -0
- package/dist/cjs/core/fetcher/Supplier.js +22 -0
- package/dist/cjs/core/fetcher/createRequestUrl.d.ts +1 -0
- package/dist/cjs/core/fetcher/createRequestUrl.js +8 -0
- package/dist/cjs/core/fetcher/getErrorResponseBody.d.ts +1 -0
- package/dist/cjs/core/fetcher/getErrorResponseBody.js +44 -0
- package/dist/cjs/core/fetcher/getFetchFn.d.ts +1 -0
- package/dist/cjs/core/fetcher/getFetchFn.js +17 -0
- package/dist/cjs/core/fetcher/getHeader.d.ts +1 -0
- package/dist/cjs/core/fetcher/getHeader.js +11 -0
- package/dist/cjs/core/fetcher/getRequestBody.d.ts +7 -0
- package/dist/cjs/core/fetcher/getRequestBody.js +23 -0
- package/dist/cjs/core/fetcher/getResponseBody.d.ts +1 -0
- package/dist/cjs/core/fetcher/getResponseBody.js +55 -0
- package/dist/cjs/core/fetcher/index.d.ts +9 -0
- package/dist/cjs/core/fetcher/index.js +15 -0
- package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -0
- package/dist/cjs/core/fetcher/makeRequest.js +42 -0
- package/dist/cjs/core/fetcher/requestWithRetries.d.ts +1 -0
- package/dist/cjs/core/fetcher/requestWithRetries.js +40 -0
- package/dist/cjs/core/fetcher/signals.d.ts +11 -0
- package/dist/cjs/core/fetcher/signals.js +36 -0
- package/dist/cjs/core/headers.d.ts +3 -0
- package/dist/cjs/core/headers.js +29 -0
- package/dist/cjs/core/index.d.ts +3 -0
- package/dist/cjs/core/index.js +42 -0
- package/dist/cjs/core/json.d.ts +15 -0
- package/dist/cjs/core/json.js +24 -0
- package/dist/cjs/core/runtime/index.d.ts +1 -0
- package/dist/cjs/core/runtime/index.js +5 -0
- package/dist/cjs/core/runtime/runtime.d.ts +9 -0
- package/dist/cjs/core/runtime/runtime.js +102 -0
- package/dist/cjs/core/url/index.d.ts +2 -0
- package/dist/cjs/core/url/index.js +7 -0
- package/dist/cjs/core/url/join.d.ts +1 -0
- package/dist/cjs/core/url/join.js +69 -0
- package/dist/cjs/core/url/qs.d.ts +6 -0
- package/dist/cjs/core/url/qs.js +64 -0
- package/dist/cjs/environments.d.ts +7 -0
- package/dist/cjs/environments.js +9 -0
- package/dist/cjs/errors/BrowserUseError.d.ts +15 -0
- package/dist/cjs/errors/BrowserUseError.js +30 -0
- package/dist/cjs/errors/BrowserUseTimeoutError.d.ts +6 -0
- package/dist/cjs/errors/BrowserUseTimeoutError.js +13 -0
- package/dist/cjs/errors/index.d.ts +2 -0
- package/dist/cjs/errors/index.js +7 -0
- package/dist/cjs/index.d.ts +7 -0
- package/dist/cjs/index.js +47 -0
- package/dist/cjs/version.d.ts +1 -0
- package/dist/cjs/version.js +4 -0
- package/dist/cjs/wrapper/BrowserUseClient.d.ts +6 -0
- package/dist/cjs/wrapper/BrowserUseClient.js +12 -0
- package/dist/cjs/wrapper/api/BrowserUseTasks.d.ts +15 -0
- package/dist/cjs/wrapper/api/BrowserUseTasks.js +89 -0
- package/dist/cjs/wrapper/lib/parse.d.ts +69 -0
- package/dist/cjs/wrapper/lib/parse.js +212 -0
- package/dist/cjs/wrapper/lib/types.d.ts +74 -0
- package/dist/cjs/wrapper/lib/types.js +13 -0
- package/dist/cjs/wrapper/lib/webhooks.d.ts +72 -0
- package/dist/cjs/wrapper/lib/webhooks.js +97 -0
- package/dist/esm/Client.d.mts +46 -0
- package/dist/esm/Client.mjs +42 -0
- package/dist/esm/api/errors/BadRequestError.d.mts +8 -0
- package/dist/esm/api/errors/BadRequestError.mjs +15 -0
- package/dist/esm/api/errors/InternalServerError.d.mts +8 -0
- package/dist/esm/api/errors/InternalServerError.mjs +15 -0
- package/dist/esm/api/errors/NotFoundError.d.mts +8 -0
- package/dist/esm/api/errors/NotFoundError.mjs +15 -0
- package/dist/esm/api/errors/PaymentRequiredError.d.mts +9 -0
- package/dist/esm/api/errors/PaymentRequiredError.mjs +15 -0
- package/dist/esm/api/errors/UnprocessableEntityError.d.mts +8 -0
- package/dist/esm/api/errors/UnprocessableEntityError.mjs +15 -0
- package/dist/esm/api/errors/index.d.mts +5 -0
- package/dist/esm/api/errors/index.mjs +5 -0
- package/dist/esm/api/index.d.mts +3 -0
- package/dist/esm/api/index.mjs +3 -0
- package/dist/esm/api/resources/accounts/client/Client.d.mts +47 -0
- package/dist/esm/api/resources/accounts/client/Client.mjs +86 -0
- package/dist/esm/api/resources/accounts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/accounts/client/index.mjs +1 -0
- package/dist/esm/api/resources/accounts/index.d.mts +1 -0
- package/dist/esm/api/resources/accounts/index.mjs +1 -0
- package/dist/esm/api/resources/files/client/Client.d.mts +72 -0
- package/dist/esm/api/resources/files/client/Client.mjs +173 -0
- package/dist/esm/api/resources/files/client/index.d.mts +2 -0
- package/dist/esm/api/resources/files/client/index.mjs +1 -0
- package/dist/esm/api/resources/files/client/requests/UploadFileRequest.d.mts +40 -0
- package/dist/esm/api/resources/files/client/requests/UploadFileRequest.mjs +22 -0
- package/dist/esm/api/resources/files/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/files/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/files/index.d.mts +1 -0
- package/dist/esm/api/resources/files/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +9 -0
- package/dist/esm/api/resources/index.mjs +9 -0
- package/dist/esm/api/resources/profiles/client/Client.d.mts +93 -0
- package/dist/esm/api/resources/profiles/client/Client.mjs +282 -0
- package/dist/esm/api/resources/profiles/client/index.d.mts +2 -0
- package/dist/esm/api/resources/profiles/client/index.mjs +1 -0
- package/dist/esm/api/resources/profiles/client/requests/ListProfilesProfilesGetRequest.d.mts +11 -0
- package/dist/esm/api/resources/profiles/client/requests/ListProfilesProfilesGetRequest.mjs +4 -0
- package/dist/esm/api/resources/profiles/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/profiles/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/profiles/index.d.mts +1 -0
- package/dist/esm/api/resources/profiles/index.mjs +1 -0
- package/dist/esm/api/resources/sessions/client/Client.d.mts +146 -0
- package/dist/esm/api/resources/sessions/client/Client.mjs +536 -0
- package/dist/esm/api/resources/sessions/client/index.d.mts +2 -0
- package/dist/esm/api/resources/sessions/client/index.mjs +1 -0
- package/dist/esm/api/resources/sessions/client/requests/CreateSessionRequest.d.mts +14 -0
- package/dist/esm/api/resources/sessions/client/requests/CreateSessionRequest.mjs +4 -0
- package/dist/esm/api/resources/sessions/client/requests/ListSessionsSessionsGetRequest.d.mts +13 -0
- package/dist/esm/api/resources/sessions/client/requests/ListSessionsSessionsGetRequest.mjs +4 -0
- package/dist/esm/api/resources/sessions/client/requests/UpdateSessionRequest.d.mts +9 -0
- package/dist/esm/api/resources/sessions/client/requests/UpdateSessionRequest.mjs +4 -0
- package/dist/esm/api/resources/sessions/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/sessions/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/sessions/index.d.mts +1 -0
- package/dist/esm/api/resources/sessions/index.mjs +1 -0
- package/dist/esm/api/resources/tasks/client/Client.d.mts +113 -0
- package/dist/esm/api/resources/tasks/client/Client.mjs +374 -0
- package/dist/esm/api/resources/tasks/client/index.d.mts +2 -0
- package/dist/esm/api/resources/tasks/client/index.mjs +1 -0
- package/dist/esm/api/resources/tasks/client/requests/CreateTaskRequest.d.mts +40 -0
- package/dist/esm/api/resources/tasks/client/requests/CreateTaskRequest.mjs +4 -0
- package/dist/esm/api/resources/tasks/client/requests/ListTasksTasksGetRequest.d.mts +16 -0
- package/dist/esm/api/resources/tasks/client/requests/ListTasksTasksGetRequest.mjs +4 -0
- package/dist/esm/api/resources/tasks/client/requests/UpdateTaskRequest.d.mts +14 -0
- package/dist/esm/api/resources/tasks/client/requests/UpdateTaskRequest.mjs +4 -0
- package/dist/esm/api/resources/tasks/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/tasks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tasks/index.d.mts +1 -0
- package/dist/esm/api/resources/tasks/index.mjs +1 -0
- package/dist/esm/api/types/AccountNotFoundError.d.mts +9 -0
- package/dist/esm/api/types/AccountNotFoundError.mjs +4 -0
- package/dist/esm/api/types/AccountView.d.mts +18 -0
- package/dist/esm/api/types/AccountView.mjs +4 -0
- package/dist/esm/api/types/BadRequestErrorBody.d.mts +5 -0
- package/dist/esm/api/types/BadRequestErrorBody.mjs +4 -0
- package/dist/esm/api/types/DownloadUrlGenerationError.d.mts +9 -0
- package/dist/esm/api/types/DownloadUrlGenerationError.mjs +4 -0
- package/dist/esm/api/types/FileView.d.mts +12 -0
- package/dist/esm/api/types/FileView.mjs +4 -0
- package/dist/esm/api/types/HttpValidationError.d.mts +7 -0
- package/dist/esm/api/types/HttpValidationError.mjs +4 -0
- package/dist/esm/api/types/InsufficientCreditsError.d.mts +9 -0
- package/dist/esm/api/types/InsufficientCreditsError.mjs +4 -0
- package/dist/esm/api/types/InternalServerErrorBody.d.mts +9 -0
- package/dist/esm/api/types/InternalServerErrorBody.mjs +4 -0
- package/dist/esm/api/types/NotFoundErrorBody.d.mts +5 -0
- package/dist/esm/api/types/NotFoundErrorBody.mjs +4 -0
- package/dist/esm/api/types/OutputFileNotFoundError.d.mts +9 -0
- package/dist/esm/api/types/OutputFileNotFoundError.mjs +4 -0
- package/dist/esm/api/types/ProfileListResponse.d.mts +17 -0
- package/dist/esm/api/types/ProfileListResponse.mjs +4 -0
- package/dist/esm/api/types/ProfileNotFoundError.d.mts +9 -0
- package/dist/esm/api/types/ProfileNotFoundError.mjs +4 -0
- package/dist/esm/api/types/ProfileView.d.mts +18 -0
- package/dist/esm/api/types/ProfileView.mjs +4 -0
- package/dist/esm/api/types/ProxyCountryCode.d.mts +16 -0
- package/dist/esm/api/types/ProxyCountryCode.mjs +15 -0
- package/dist/esm/api/types/SessionHasRunningTaskError.d.mts +9 -0
- package/dist/esm/api/types/SessionHasRunningTaskError.mjs +4 -0
- package/dist/esm/api/types/SessionItemView.d.mts +19 -0
- package/dist/esm/api/types/SessionItemView.mjs +4 -0
- package/dist/esm/api/types/SessionListResponse.d.mts +17 -0
- package/dist/esm/api/types/SessionListResponse.mjs +4 -0
- package/dist/esm/api/types/SessionNotFoundError.d.mts +9 -0
- package/dist/esm/api/types/SessionNotFoundError.mjs +4 -0
- package/dist/esm/api/types/SessionStatus.d.mts +15 -0
- package/dist/esm/api/types/SessionStatus.mjs +7 -0
- package/dist/esm/api/types/SessionStoppedError.d.mts +9 -0
- package/dist/esm/api/types/SessionStoppedError.mjs +4 -0
- package/dist/esm/api/types/SessionUpdateAction.d.mts +10 -0
- package/dist/esm/api/types/SessionUpdateAction.mjs +4 -0
- package/dist/esm/api/types/SessionView.d.mts +23 -0
- package/dist/esm/api/types/SessionView.mjs +4 -0
- package/dist/esm/api/types/ShareNotFoundError.d.mts +9 -0
- package/dist/esm/api/types/ShareNotFoundError.mjs +4 -0
- package/dist/esm/api/types/ShareView.d.mts +16 -0
- package/dist/esm/api/types/ShareView.mjs +4 -0
- package/dist/esm/api/types/SupportedLlMs.d.mts +17 -0
- package/dist/esm/api/types/SupportedLlMs.mjs +16 -0
- package/dist/esm/api/types/TaskCreatedResponse.d.mts +10 -0
- package/dist/esm/api/types/TaskCreatedResponse.mjs +4 -0
- package/dist/esm/api/types/TaskItemView.d.mts +32 -0
- package/dist/esm/api/types/TaskItemView.mjs +4 -0
- package/dist/esm/api/types/TaskListResponse.d.mts +17 -0
- package/dist/esm/api/types/TaskListResponse.mjs +4 -0
- package/dist/esm/api/types/TaskLogFileResponse.d.mts +10 -0
- package/dist/esm/api/types/TaskLogFileResponse.mjs +4 -0
- package/dist/esm/api/types/TaskNotFoundError.d.mts +9 -0
- package/dist/esm/api/types/TaskNotFoundError.mjs +4 -0
- package/dist/esm/api/types/TaskOutputFileResponse.d.mts +14 -0
- package/dist/esm/api/types/TaskOutputFileResponse.mjs +4 -0
- package/dist/esm/api/types/TaskStatus.d.mts +19 -0
- package/dist/esm/api/types/TaskStatus.mjs +9 -0
- package/dist/esm/api/types/TaskStepView.d.mts +22 -0
- package/dist/esm/api/types/TaskStepView.mjs +4 -0
- package/dist/esm/api/types/TaskUpdateAction.d.mts +19 -0
- package/dist/esm/api/types/TaskUpdateAction.mjs +9 -0
- package/dist/esm/api/types/TaskView.d.mts +34 -0
- package/dist/esm/api/types/TaskView.mjs +4 -0
- package/dist/esm/api/types/UnsupportedContentTypeError.d.mts +9 -0
- package/dist/esm/api/types/UnsupportedContentTypeError.mjs +4 -0
- package/dist/esm/api/types/UploadFilePresignedUrlResponse.d.mts +18 -0
- package/dist/esm/api/types/UploadFilePresignedUrlResponse.mjs +4 -0
- package/dist/esm/api/types/ValidationError.d.mts +14 -0
- package/dist/esm/api/types/ValidationError.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +38 -0
- package/dist/esm/api/types/index.mjs +38 -0
- package/dist/esm/core/fetcher/APIResponse.d.mts +20 -0
- package/dist/esm/core/fetcher/APIResponse.mjs +1 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +20 -0
- package/dist/esm/core/fetcher/BinaryResponse.mjs +14 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +40 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +116 -0
- package/dist/esm/core/fetcher/Headers.d.mts +2 -0
- package/dist/esm/core/fetcher/Headers.mjs +82 -0
- package/dist/esm/core/fetcher/HttpResponsePromise.d.mts +58 -0
- package/dist/esm/core/fetcher/HttpResponsePromise.mjs +99 -0
- package/dist/esm/core/fetcher/RawResponse.d.mts +29 -0
- package/dist/esm/core/fetcher/RawResponse.mjs +40 -0
- package/dist/esm/core/fetcher/ResponseWithBody.d.mts +4 -0
- package/dist/esm/core/fetcher/ResponseWithBody.mjs +3 -0
- package/dist/esm/core/fetcher/Supplier.d.mts +4 -0
- package/dist/esm/core/fetcher/Supplier.mjs +19 -0
- package/dist/esm/core/fetcher/createRequestUrl.d.mts +1 -0
- package/dist/esm/core/fetcher/createRequestUrl.mjs +5 -0
- package/dist/esm/core/fetcher/getErrorResponseBody.d.mts +1 -0
- package/dist/esm/core/fetcher/getErrorResponseBody.mjs +41 -0
- package/dist/esm/core/fetcher/getFetchFn.d.mts +1 -0
- package/dist/esm/core/fetcher/getFetchFn.mjs +14 -0
- package/dist/esm/core/fetcher/getHeader.d.mts +1 -0
- package/dist/esm/core/fetcher/getHeader.mjs +8 -0
- package/dist/esm/core/fetcher/getRequestBody.d.mts +7 -0
- package/dist/esm/core/fetcher/getRequestBody.mjs +20 -0
- package/dist/esm/core/fetcher/getResponseBody.d.mts +1 -0
- package/dist/esm/core/fetcher/getResponseBody.mjs +52 -0
- package/dist/esm/core/fetcher/index.d.mts +9 -0
- package/dist/esm/core/fetcher/index.mjs +5 -0
- package/dist/esm/core/fetcher/makeRequest.d.mts +1 -0
- package/dist/esm/core/fetcher/makeRequest.mjs +38 -0
- package/dist/esm/core/fetcher/requestWithRetries.d.mts +1 -0
- package/dist/esm/core/fetcher/requestWithRetries.mjs +37 -0
- package/dist/esm/core/fetcher/signals.d.mts +11 -0
- package/dist/esm/core/fetcher/signals.mjs +32 -0
- package/dist/esm/core/headers.d.mts +3 -0
- package/dist/esm/core/headers.mjs +25 -0
- package/dist/esm/core/index.d.mts +3 -0
- package/dist/esm/core/index.mjs +3 -0
- package/dist/esm/core/json.d.mts +15 -0
- package/dist/esm/core/json.mjs +19 -0
- package/dist/esm/core/runtime/index.d.mts +1 -0
- package/dist/esm/core/runtime/index.mjs +1 -0
- package/dist/esm/core/runtime/runtime.d.mts +9 -0
- package/dist/esm/core/runtime/runtime.mjs +99 -0
- package/dist/esm/core/url/index.d.mts +2 -0
- package/dist/esm/core/url/index.mjs +2 -0
- package/dist/esm/core/url/join.d.mts +1 -0
- package/dist/esm/core/url/join.mjs +66 -0
- package/dist/esm/core/url/qs.d.mts +6 -0
- package/dist/esm/core/url/qs.mjs +61 -0
- package/dist/esm/environments.d.mts +7 -0
- package/dist/esm/environments.mjs +6 -0
- package/dist/esm/errors/BrowserUseError.d.mts +15 -0
- package/dist/esm/errors/BrowserUseError.mjs +26 -0
- package/dist/esm/errors/BrowserUseTimeoutError.d.mts +6 -0
- package/dist/esm/errors/BrowserUseTimeoutError.mjs +9 -0
- package/dist/esm/errors/index.d.mts +2 -0
- package/dist/esm/errors/index.mjs +2 -0
- package/dist/esm/index.d.mts +7 -0
- package/dist/esm/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -0
- package/dist/esm/version.mjs +1 -0
- package/dist/esm/wrapper/BrowserUseClient.d.mts +6 -0
- package/dist/esm/wrapper/BrowserUseClient.mjs +8 -0
- package/dist/esm/wrapper/api/BrowserUseTasks.d.mts +15 -0
- package/dist/esm/wrapper/api/BrowserUseTasks.mjs +52 -0
- package/dist/esm/wrapper/lib/parse.d.mts +69 -0
- package/dist/esm/wrapper/lib/parse.mjs +203 -0
- package/dist/esm/wrapper/lib/types.d.mts +74 -0
- package/dist/esm/wrapper/lib/types.mjs +9 -0
- package/dist/esm/wrapper/lib/webhooks.d.mts +72 -0
- package/dist/esm/wrapper/lib/webhooks.mjs +89 -0
- package/package.json +83 -158
- package/reference.md +1302 -0
- package/CHANGELOG.md +0 -157
- package/LICENSE +0 -201
- package/api-promise.d.mts +0 -2
- package/api-promise.d.mts.map +0 -1
- package/api-promise.d.ts +0 -2
- package/api-promise.d.ts.map +0 -1
- package/api-promise.js +0 -6
- package/api-promise.js.map +0 -1
- package/api-promise.mjs +0 -2
- package/api-promise.mjs.map +0 -1
- package/client.d.mts +0 -192
- package/client.d.mts.map +0 -1
- package/client.d.ts +0 -192
- package/client.d.ts.map +0 -1
- package/client.js +0 -473
- package/client.js.map +0 -1
- package/client.mjs +0 -469
- package/client.mjs.map +0 -1
- package/core/api-promise.d.mts +0 -46
- package/core/api-promise.d.mts.map +0 -1
- package/core/api-promise.d.ts +0 -46
- package/core/api-promise.d.ts.map +0 -1
- package/core/api-promise.js +0 -74
- package/core/api-promise.js.map +0 -1
- package/core/api-promise.mjs +0 -70
- package/core/api-promise.mjs.map +0 -1
- package/core/error.d.mts +0 -46
- package/core/error.d.mts.map +0 -1
- package/core/error.d.ts +0 -46
- package/core/error.d.ts.map +0 -1
- package/core/error.js +0 -113
- package/core/error.js.map +0 -1
- package/core/error.mjs +0 -97
- package/core/error.mjs.map +0 -1
- package/core/resource.d.mts +0 -6
- package/core/resource.d.mts.map +0 -1
- package/core/resource.d.ts +0 -6
- package/core/resource.d.ts.map +0 -1
- package/core/resource.js +0 -11
- package/core/resource.js.map +0 -1
- package/core/resource.mjs +0 -7
- package/core/resource.mjs.map +0 -1
- package/core/uploads.d.mts +0 -3
- package/core/uploads.d.mts.map +0 -1
- package/core/uploads.d.ts +0 -3
- package/core/uploads.d.ts.map +0 -1
- package/core/uploads.js +0 -6
- package/core/uploads.js.map +0 -1
- package/core/uploads.mjs +0 -2
- package/core/uploads.mjs.map +0 -1
- package/error.d.mts +0 -2
- package/error.d.mts.map +0 -1
- package/error.d.ts +0 -2
- package/error.d.ts.map +0 -1
- package/error.js +0 -6
- package/error.js.map +0 -1
- package/error.mjs +0 -2
- package/error.mjs.map +0 -1
- package/index.d.mts +0 -6
- package/index.d.mts.map +0 -1
- package/index.d.ts +0 -6
- package/index.d.ts.map +0 -1
- package/index.js +0 -30
- package/index.js.map +0 -1
- package/index.mjs +0 -7
- package/index.mjs.map +0 -1
- package/internal/builtin-types.d.mts +0 -73
- package/internal/builtin-types.d.mts.map +0 -1
- package/internal/builtin-types.d.ts +0 -73
- package/internal/builtin-types.d.ts.map +0 -1
- package/internal/builtin-types.js +0 -4
- package/internal/builtin-types.js.map +0 -1
- package/internal/builtin-types.mjs +0 -3
- package/internal/builtin-types.mjs.map +0 -1
- package/internal/detect-platform.d.mts +0 -15
- package/internal/detect-platform.d.mts.map +0 -1
- package/internal/detect-platform.d.ts +0 -15
- package/internal/detect-platform.d.ts.map +0 -1
- package/internal/detect-platform.js +0 -162
- package/internal/detect-platform.js.map +0 -1
- package/internal/detect-platform.mjs +0 -157
- package/internal/detect-platform.mjs.map +0 -1
- package/internal/errors.d.mts +0 -3
- package/internal/errors.d.mts.map +0 -1
- package/internal/errors.d.ts +0 -3
- package/internal/errors.d.ts.map +0 -1
- package/internal/errors.js +0 -41
- package/internal/errors.js.map +0 -1
- package/internal/errors.mjs +0 -36
- package/internal/errors.mjs.map +0 -1
- package/internal/headers.d.mts +0 -20
- package/internal/headers.d.mts.map +0 -1
- package/internal/headers.d.ts +0 -20
- package/internal/headers.d.ts.map +0 -1
- package/internal/headers.js +0 -79
- package/internal/headers.js.map +0 -1
- package/internal/headers.mjs +0 -74
- package/internal/headers.mjs.map +0 -1
- package/internal/parse.d.mts +0 -12
- package/internal/parse.d.mts.map +0 -1
- package/internal/parse.d.ts +0 -12
- package/internal/parse.d.ts.map +0 -1
- package/internal/parse.js +0 -35
- package/internal/parse.js.map +0 -1
- package/internal/parse.mjs +0 -32
- package/internal/parse.mjs.map +0 -1
- package/internal/request-options.d.mts +0 -75
- package/internal/request-options.d.mts.map +0 -1
- package/internal/request-options.d.ts +0 -75
- package/internal/request-options.d.ts.map +0 -1
- package/internal/request-options.js +0 -14
- package/internal/request-options.js.map +0 -1
- package/internal/request-options.mjs +0 -10
- package/internal/request-options.mjs.map +0 -1
- package/internal/shim-types.d.mts +0 -17
- package/internal/shim-types.d.mts.map +0 -1
- package/internal/shim-types.d.ts +0 -17
- package/internal/shim-types.d.ts.map +0 -1
- package/internal/shim-types.js +0 -4
- package/internal/shim-types.js.map +0 -1
- package/internal/shim-types.mjs +0 -3
- package/internal/shim-types.mjs.map +0 -1
- package/internal/shims.d.mts +0 -20
- package/internal/shims.d.mts.map +0 -1
- package/internal/shims.d.ts +0 -20
- package/internal/shims.d.ts.map +0 -1
- package/internal/shims.js +0 -92
- package/internal/shims.js.map +0 -1
- package/internal/shims.mjs +0 -85
- package/internal/shims.mjs.map +0 -1
- package/internal/to-file.d.mts +0 -45
- package/internal/to-file.d.mts.map +0 -1
- package/internal/to-file.d.ts +0 -45
- package/internal/to-file.d.ts.map +0 -1
- package/internal/to-file.js +0 -91
- package/internal/to-file.js.map +0 -1
- package/internal/to-file.mjs +0 -88
- package/internal/to-file.mjs.map +0 -1
- package/internal/tslib.js +0 -85
- package/internal/tslib.mjs +0 -17
- package/internal/types.d.mts +0 -69
- package/internal/types.d.mts.map +0 -1
- package/internal/types.d.ts +0 -69
- package/internal/types.d.ts.map +0 -1
- package/internal/types.js +0 -4
- package/internal/types.js.map +0 -1
- package/internal/types.mjs +0 -3
- package/internal/types.mjs.map +0 -1
- package/internal/uploads.d.mts +0 -42
- package/internal/uploads.d.mts.map +0 -1
- package/internal/uploads.d.ts +0 -42
- package/internal/uploads.d.ts.map +0 -1
- package/internal/uploads.js +0 -141
- package/internal/uploads.js.map +0 -1
- package/internal/uploads.mjs +0 -131
- package/internal/uploads.mjs.map +0 -1
- package/internal/utils/base64.d.mts +0 -3
- package/internal/utils/base64.d.mts.map +0 -1
- package/internal/utils/base64.d.ts +0 -3
- package/internal/utils/base64.d.ts.map +0 -1
- package/internal/utils/base64.js +0 -38
- package/internal/utils/base64.js.map +0 -1
- package/internal/utils/base64.mjs +0 -33
- package/internal/utils/base64.mjs.map +0 -1
- package/internal/utils/bytes.d.mts +0 -4
- package/internal/utils/bytes.d.mts.map +0 -1
- package/internal/utils/bytes.d.ts +0 -4
- package/internal/utils/bytes.d.ts.map +0 -1
- package/internal/utils/bytes.js +0 -31
- package/internal/utils/bytes.js.map +0 -1
- package/internal/utils/bytes.mjs +0 -26
- package/internal/utils/bytes.mjs.map +0 -1
- package/internal/utils/env.d.mts +0 -9
- package/internal/utils/env.d.mts.map +0 -1
- package/internal/utils/env.d.ts +0 -9
- package/internal/utils/env.d.ts.map +0 -1
- package/internal/utils/env.js +0 -22
- package/internal/utils/env.js.map +0 -1
- package/internal/utils/env.mjs +0 -18
- package/internal/utils/env.mjs.map +0 -1
- package/internal/utils/log.d.mts +0 -37
- package/internal/utils/log.d.mts.map +0 -1
- package/internal/utils/log.d.ts +0 -37
- package/internal/utils/log.d.ts.map +0 -1
- package/internal/utils/log.js +0 -86
- package/internal/utils/log.js.map +0 -1
- package/internal/utils/log.mjs +0 -80
- package/internal/utils/log.mjs.map +0 -1
- package/internal/utils/path.d.mts +0 -15
- package/internal/utils/path.d.mts.map +0 -1
- package/internal/utils/path.d.ts +0 -15
- package/internal/utils/path.d.ts.map +0 -1
- package/internal/utils/path.js +0 -79
- package/internal/utils/path.js.map +0 -1
- package/internal/utils/path.mjs +0 -74
- package/internal/utils/path.mjs.map +0 -1
- package/internal/utils/sleep.d.mts +0 -2
- package/internal/utils/sleep.d.mts.map +0 -1
- package/internal/utils/sleep.d.ts +0 -2
- package/internal/utils/sleep.d.ts.map +0 -1
- package/internal/utils/sleep.js +0 -7
- package/internal/utils/sleep.js.map +0 -1
- package/internal/utils/sleep.mjs +0 -3
- package/internal/utils/sleep.mjs.map +0 -1
- package/internal/utils/uuid.d.mts +0 -5
- package/internal/utils/uuid.d.mts.map +0 -1
- package/internal/utils/uuid.d.ts +0 -5
- package/internal/utils/uuid.d.ts.map +0 -1
- package/internal/utils/uuid.js +0 -19
- package/internal/utils/uuid.js.map +0 -1
- package/internal/utils/uuid.mjs +0 -15
- package/internal/utils/uuid.mjs.map +0 -1
- package/internal/utils/values.d.mts +0 -18
- package/internal/utils/values.d.mts.map +0 -1
- package/internal/utils/values.d.ts +0 -18
- package/internal/utils/values.d.ts.map +0 -1
- package/internal/utils/values.js +0 -112
- package/internal/utils/values.js.map +0 -1
- package/internal/utils/values.mjs +0 -94
- package/internal/utils/values.mjs.map +0 -1
- package/internal/utils.d.mts +0 -7
- package/internal/utils.d.mts.map +0 -1
- package/internal/utils.d.ts +0 -7
- package/internal/utils.d.ts.map +0 -1
- package/internal/utils.js +0 -11
- package/internal/utils.js.map +0 -1
- package/internal/utils.mjs +0 -8
- package/internal/utils.mjs.map +0 -1
- package/lib/bin/auth.d.mts +0 -10
- package/lib/bin/auth.d.mts.map +0 -1
- package/lib/bin/auth.d.ts +0 -10
- package/lib/bin/auth.d.ts.map +0 -1
- package/lib/bin/auth.js +0 -52
- package/lib/bin/auth.js.map +0 -1
- package/lib/bin/auth.mjs +0 -47
- package/lib/bin/auth.mjs.map +0 -1
- package/lib/bin/cli.d.mts +0 -3
- package/lib/bin/cli.d.mts.map +0 -1
- package/lib/bin/cli.d.ts +0 -3
- package/lib/bin/cli.d.ts.map +0 -1
- package/lib/bin/cli.js +0 -12
- package/lib/bin/cli.js.map +0 -1
- package/lib/bin/cli.mjs +0 -10
- package/lib/bin/cli.mjs.map +0 -1
- package/lib/bin/commands/listen.d.mts +0 -3
- package/lib/bin/commands/listen.d.mts.map +0 -1
- package/lib/bin/commands/listen.d.ts +0 -3
- package/lib/bin/commands/listen.d.ts.map +0 -1
- package/lib/bin/commands/listen.js +0 -143
- package/lib/bin/commands/listen.js.map +0 -1
- package/lib/bin/commands/listen.mjs +0 -140
- package/lib/bin/commands/listen.mjs.map +0 -1
- package/lib/nextjs/hooks/useBrowserUse.d.mts +0 -7
- package/lib/nextjs/hooks/useBrowserUse.d.mts.map +0 -1
- package/lib/nextjs/hooks/useBrowserUse.d.ts +0 -7
- package/lib/nextjs/hooks/useBrowserUse.d.ts.map +0 -1
- package/lib/nextjs/hooks/useBrowserUse.js +0 -30
- package/lib/nextjs/hooks/useBrowserUse.js.map +0 -1
- package/lib/nextjs/hooks/useBrowserUse.mjs +0 -27
- package/lib/nextjs/hooks/useBrowserUse.mjs.map +0 -1
- package/lib/nextjs/server/utils.d.mts +0 -26
- package/lib/nextjs/server/utils.d.mts.map +0 -1
- package/lib/nextjs/server/utils.d.ts +0 -26
- package/lib/nextjs/server/utils.d.ts.map +0 -1
- package/lib/nextjs/server/utils.js +0 -42
- package/lib/nextjs/server/utils.js.map +0 -1
- package/lib/nextjs/server/utils.mjs +0 -39
- package/lib/nextjs/server/utils.mjs.map +0 -1
- package/lib/parse.d.mts +0 -11
- package/lib/parse.d.mts.map +0 -1
- package/lib/parse.d.ts +0 -11
- package/lib/parse.d.ts.map +0 -1
- package/lib/parse.js +0 -32
- package/lib/parse.js.map +0 -1
- package/lib/parse.mjs +0 -27
- package/lib/parse.mjs.map +0 -1
- package/lib/stream.d.mts +0 -7
- package/lib/stream.d.mts.map +0 -1
- package/lib/stream.d.ts +0 -7
- package/lib/stream.d.ts.map +0 -1
- package/lib/stream.js +0 -16
- package/lib/stream.js.map +0 -1
- package/lib/stream.mjs +0 -12
- package/lib/stream.mjs.map +0 -1
- package/lib/types.d.mts +0 -75
- package/lib/types.d.mts.map +0 -1
- package/lib/types.d.ts +0 -75
- package/lib/types.d.ts.map +0 -1
- package/lib/types.js +0 -14
- package/lib/types.js.map +0 -1
- package/lib/types.mjs +0 -10
- package/lib/types.mjs.map +0 -1
- package/lib/webhooks.d.mts +0 -73
- package/lib/webhooks.d.mts.map +0 -1
- package/lib/webhooks.d.ts +0 -73
- package/lib/webhooks.d.ts.map +0 -1
- package/lib/webhooks.js +0 -85
- package/lib/webhooks.js.map +0 -1
- package/lib/webhooks.mjs +0 -79
- package/lib/webhooks.mjs.map +0 -1
- package/resource.d.mts +0 -2
- package/resource.d.mts.map +0 -1
- package/resource.d.ts +0 -2
- package/resource.d.ts.map +0 -1
- package/resource.js +0 -6
- package/resource.js.map +0 -1
- package/resource.mjs +0 -2
- package/resource.mjs.map +0 -1
- package/resources/agent-profiles.d.mts +0 -174
- package/resources/agent-profiles.d.mts.map +0 -1
- package/resources/agent-profiles.d.ts +0 -174
- package/resources/agent-profiles.d.ts.map +0 -1
- package/resources/agent-profiles.js +0 -125
- package/resources/agent-profiles.js.map +0 -1
- package/resources/agent-profiles.mjs +0 -121
- package/resources/agent-profiles.mjs.map +0 -1
- package/resources/browser-profiles.d.mts +0 -179
- package/resources/browser-profiles.d.mts.map +0 -1
- package/resources/browser-profiles.d.ts +0 -179
- package/resources/browser-profiles.d.ts.map +0 -1
- package/resources/browser-profiles.js +0 -126
- package/resources/browser-profiles.js.map +0 -1
- package/resources/browser-profiles.mjs +0 -122
- package/resources/browser-profiles.mjs.map +0 -1
- package/resources/index.d.mts +0 -6
- package/resources/index.d.mts.map +0 -1
- package/resources/index.d.ts +0 -6
- package/resources/index.d.ts.map +0 -1
- package/resources/index.js +0 -15
- package/resources/index.js.map +0 -1
- package/resources/index.mjs +0 -7
- package/resources/index.mjs.map +0 -1
- package/resources/sessions/index.d.mts +0 -3
- package/resources/sessions/index.d.mts.map +0 -1
- package/resources/sessions/index.d.ts +0 -3
- package/resources/sessions/index.d.ts.map +0 -1
- package/resources/sessions/index.js +0 -9
- package/resources/sessions/index.js.map +0 -1
- package/resources/sessions/index.mjs +0 -4
- package/resources/sessions/index.mjs.map +0 -1
- package/resources/sessions/public-share.d.mts +0 -89
- package/resources/sessions/public-share.d.mts.map +0 -1
- package/resources/sessions/public-share.d.ts +0 -89
- package/resources/sessions/public-share.d.ts.map +0 -1
- package/resources/sessions/public-share.js +0 -86
- package/resources/sessions/public-share.js.map +0 -1
- package/resources/sessions/public-share.mjs +0 -82
- package/resources/sessions/public-share.mjs.map +0 -1
- package/resources/sessions/sessions.d.mts +0 -186
- package/resources/sessions/sessions.d.mts.map +0 -1
- package/resources/sessions/sessions.d.ts +0 -186
- package/resources/sessions/sessions.d.ts.map +0 -1
- package/resources/sessions/sessions.js +0 -113
- package/resources/sessions/sessions.js.map +0 -1
- package/resources/sessions/sessions.mjs +0 -108
- package/resources/sessions/sessions.mjs.map +0 -1
- package/resources/sessions.d.mts +0 -2
- package/resources/sessions.d.mts.map +0 -1
- package/resources/sessions.d.ts +0 -2
- package/resources/sessions.d.ts.map +0 -1
- package/resources/sessions.js +0 -6
- package/resources/sessions.js.map +0 -1
- package/resources/sessions.mjs +0 -3
- package/resources/sessions.mjs.map +0 -1
- package/resources/tasks.d.mts +0 -529
- package/resources/tasks.d.mts.map +0 -1
- package/resources/tasks.d.ts +0 -529
- package/resources/tasks.d.ts.map +0 -1
- package/resources/tasks.js +0 -238
- package/resources/tasks.js.map +0 -1
- package/resources/tasks.mjs +0 -234
- package/resources/tasks.mjs.map +0 -1
- package/resources/users/index.d.mts +0 -3
- package/resources/users/index.d.mts.map +0 -1
- package/resources/users/index.d.ts +0 -3
- package/resources/users/index.d.ts.map +0 -1
- package/resources/users/index.js +0 -9
- package/resources/users/index.js.map +0 -1
- package/resources/users/index.mjs +0 -4
- package/resources/users/index.mjs.map +0 -1
- package/resources/users/me/files.d.mts +0 -64
- package/resources/users/me/files.d.mts.map +0 -1
- package/resources/users/me/files.d.ts +0 -64
- package/resources/users/me/files.d.ts.map +0 -1
- package/resources/users/me/files.js +0 -43
- package/resources/users/me/files.js.map +0 -1
- package/resources/users/me/files.mjs +0 -39
- package/resources/users/me/files.mjs.map +0 -1
- package/resources/users/me/index.d.mts +0 -3
- package/resources/users/me/index.d.mts.map +0 -1
- package/resources/users/me/index.d.ts +0 -3
- package/resources/users/me/index.d.ts.map +0 -1
- package/resources/users/me/index.js +0 -9
- package/resources/users/me/index.js.map +0 -1
- package/resources/users/me/index.mjs +0 -4
- package/resources/users/me/index.mjs.map +0 -1
- package/resources/users/me/me.d.mts +0 -50
- package/resources/users/me/me.d.mts.map +0 -1
- package/resources/users/me/me.d.ts +0 -50
- package/resources/users/me/me.d.ts.map +0 -1
- package/resources/users/me/me.js +0 -41
- package/resources/users/me/me.js.map +0 -1
- package/resources/users/me/me.mjs +0 -36
- package/resources/users/me/me.mjs.map +0 -1
- package/resources/users/me.d.mts +0 -2
- package/resources/users/me.d.mts.map +0 -1
- package/resources/users/me.d.ts +0 -2
- package/resources/users/me.d.ts.map +0 -1
- package/resources/users/me.js +0 -6
- package/resources/users/me.js.map +0 -1
- package/resources/users/me.mjs +0 -3
- package/resources/users/me.mjs.map +0 -1
- package/resources/users/users.d.mts +0 -10
- package/resources/users/users.d.mts.map +0 -1
- package/resources/users/users.d.ts +0 -10
- package/resources/users/users.d.ts.map +0 -1
- package/resources/users/users.js +0 -17
- package/resources/users/users.js.map +0 -1
- package/resources/users/users.mjs +0 -12
- package/resources/users/users.mjs.map +0 -1
- package/resources/users.d.mts +0 -2
- package/resources/users.d.mts.map +0 -1
- package/resources/users.d.ts +0 -2
- package/resources/users.d.ts.map +0 -1
- package/resources/users.js +0 -6
- package/resources/users.js.map +0 -1
- package/resources/users.mjs +0 -3
- package/resources/users.mjs.map +0 -1
- package/resources.d.mts +0 -2
- package/resources.d.mts.map +0 -1
- package/resources.d.ts +0 -2
- package/resources.d.ts.map +0 -1
- package/resources.js +0 -5
- package/resources.js.map +0 -1
- package/resources.mjs +0 -2
- package/resources.mjs.map +0 -1
- package/src/api-promise.ts +0 -2
- package/src/client.ts +0 -824
- package/src/core/README.md +0 -3
- package/src/core/api-promise.ts +0 -92
- package/src/core/error.ts +0 -130
- package/src/core/resource.ts +0 -11
- package/src/core/uploads.ts +0 -2
- package/src/error.ts +0 -2
- package/src/index.ts +0 -22
- package/src/internal/README.md +0 -3
- package/src/internal/builtin-types.ts +0 -93
- package/src/internal/detect-platform.ts +0 -196
- package/src/internal/errors.ts +0 -33
- package/src/internal/headers.ts +0 -97
- package/src/internal/parse.ts +0 -50
- package/src/internal/request-options.ts +0 -91
- package/src/internal/shim-types.ts +0 -26
- package/src/internal/shims.ts +0 -107
- package/src/internal/to-file.ts +0 -154
- package/src/internal/types.ts +0 -95
- package/src/internal/uploads.ts +0 -187
- package/src/internal/utils/base64.ts +0 -40
- package/src/internal/utils/bytes.ts +0 -32
- package/src/internal/utils/env.ts +0 -18
- package/src/internal/utils/log.ts +0 -127
- package/src/internal/utils/path.ts +0 -88
- package/src/internal/utils/sleep.ts +0 -3
- package/src/internal/utils/uuid.ts +0 -17
- package/src/internal/utils/values.ts +0 -105
- package/src/internal/utils.ts +0 -8
- package/src/lib/.keep +0 -4
- package/src/lib/bin/auth.ts +0 -63
- package/src/lib/bin/cli.ts +0 -11
- package/src/lib/bin/commands/listen.ts +0 -183
- package/src/lib/nextjs/hooks/useBrowserUse.ts +0 -37
- package/src/lib/nextjs/server/utils.ts +0 -69
- package/src/lib/parse.ts +0 -46
- package/src/lib/stream.ts +0 -14
- package/src/lib/types.ts +0 -73
- package/src/lib/webhooks.ts +0 -119
- package/src/resource.ts +0 -2
- package/src/resources/agent-profiles.ts +0 -245
- package/src/resources/browser-profiles.ts +0 -255
- package/src/resources/index.ts +0 -46
- package/src/resources/sessions/index.ts +0 -11
- package/src/resources/sessions/public-share.ts +0 -109
- package/src/resources/sessions/sessions.ts +0 -240
- package/src/resources/sessions.ts +0 -3
- package/src/resources/tasks.ts +0 -783
- package/src/resources/users/index.ts +0 -4
- package/src/resources/users/me/files.ts +0 -95
- package/src/resources/users/me/index.ts +0 -4
- package/src/resources/users/me/me.ts +0 -68
- package/src/resources/users/me.ts +0 -3
- package/src/resources/users/users.ts +0 -15
- package/src/resources/users.ts +0 -3
- package/src/resources.ts +0 -1
- package/src/tsconfig.json +0 -11
- package/src/uploads.ts +0 -2
- package/src/version.ts +0 -1
- package/uploads.d.mts +0 -2
- package/uploads.d.mts.map +0 -1
- package/uploads.d.ts +0 -2
- package/uploads.d.ts.map +0 -1
- package/uploads.js +0 -6
- package/uploads.js.map +0 -1
- package/uploads.mjs +0 -2
- package/uploads.mjs.map +0 -1
- package/version.d.mts +0 -2
- package/version.d.mts.map +0 -1
- package/version.d.ts +0 -2
- package/version.d.ts.map +0 -1
- package/version.js +0 -5
- package/version.js.map +0 -1
- package/version.mjs +0 -2
- package/version.mjs.map +0 -1
package/reference.md
ADDED
|
@@ -0,0 +1,1302 @@
|
|
|
1
|
+
# Reference
|
|
2
|
+
|
|
3
|
+
## Accounts
|
|
4
|
+
|
|
5
|
+
<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">getAccountMe</a>() -> BrowserUse.AccountView</code></summary>
|
|
6
|
+
<dl>
|
|
7
|
+
<dd>
|
|
8
|
+
|
|
9
|
+
#### 📝 Description
|
|
10
|
+
|
|
11
|
+
<dl>
|
|
12
|
+
<dd>
|
|
13
|
+
|
|
14
|
+
<dl>
|
|
15
|
+
<dd>
|
|
16
|
+
|
|
17
|
+
Get authenticated account information including credit balances and account details.
|
|
18
|
+
|
|
19
|
+
</dd>
|
|
20
|
+
</dl>
|
|
21
|
+
</dd>
|
|
22
|
+
</dl>
|
|
23
|
+
|
|
24
|
+
#### 🔌 Usage
|
|
25
|
+
|
|
26
|
+
<dl>
|
|
27
|
+
<dd>
|
|
28
|
+
|
|
29
|
+
<dl>
|
|
30
|
+
<dd>
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
await client.accounts.getAccountMe();
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
</dd>
|
|
37
|
+
</dl>
|
|
38
|
+
</dd>
|
|
39
|
+
</dl>
|
|
40
|
+
|
|
41
|
+
#### ⚙️ Parameters
|
|
42
|
+
|
|
43
|
+
<dl>
|
|
44
|
+
<dd>
|
|
45
|
+
|
|
46
|
+
<dl>
|
|
47
|
+
<dd>
|
|
48
|
+
|
|
49
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
50
|
+
|
|
51
|
+
</dd>
|
|
52
|
+
</dl>
|
|
53
|
+
</dd>
|
|
54
|
+
</dl>
|
|
55
|
+
|
|
56
|
+
</dd>
|
|
57
|
+
</dl>
|
|
58
|
+
</details>
|
|
59
|
+
|
|
60
|
+
## Tasks
|
|
61
|
+
|
|
62
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">listTasks</a>({ ...params }) -> BrowserUse.TaskListResponse</code></summary>
|
|
63
|
+
<dl>
|
|
64
|
+
<dd>
|
|
65
|
+
|
|
66
|
+
#### 📝 Description
|
|
67
|
+
|
|
68
|
+
<dl>
|
|
69
|
+
<dd>
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dd>
|
|
73
|
+
|
|
74
|
+
Get paginated list of AI agent tasks with optional filtering by session and status.
|
|
75
|
+
|
|
76
|
+
</dd>
|
|
77
|
+
</dl>
|
|
78
|
+
</dd>
|
|
79
|
+
</dl>
|
|
80
|
+
|
|
81
|
+
#### 🔌 Usage
|
|
82
|
+
|
|
83
|
+
<dl>
|
|
84
|
+
<dd>
|
|
85
|
+
|
|
86
|
+
<dl>
|
|
87
|
+
<dd>
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
await client.tasks.listTasks();
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
</dd>
|
|
94
|
+
</dl>
|
|
95
|
+
</dd>
|
|
96
|
+
</dl>
|
|
97
|
+
|
|
98
|
+
#### ⚙️ Parameters
|
|
99
|
+
|
|
100
|
+
<dl>
|
|
101
|
+
<dd>
|
|
102
|
+
|
|
103
|
+
<dl>
|
|
104
|
+
<dd>
|
|
105
|
+
|
|
106
|
+
**request:** `BrowserUse.ListTasksTasksGetRequest`
|
|
107
|
+
|
|
108
|
+
</dd>
|
|
109
|
+
</dl>
|
|
110
|
+
|
|
111
|
+
<dl>
|
|
112
|
+
<dd>
|
|
113
|
+
|
|
114
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
115
|
+
|
|
116
|
+
</dd>
|
|
117
|
+
</dl>
|
|
118
|
+
</dd>
|
|
119
|
+
</dl>
|
|
120
|
+
|
|
121
|
+
</dd>
|
|
122
|
+
</dl>
|
|
123
|
+
</details>
|
|
124
|
+
|
|
125
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">createTask</a>({ ...params }) -> BrowserUse.TaskCreatedResponse</code></summary>
|
|
126
|
+
<dl>
|
|
127
|
+
<dd>
|
|
128
|
+
|
|
129
|
+
#### 📝 Description
|
|
130
|
+
|
|
131
|
+
<dl>
|
|
132
|
+
<dd>
|
|
133
|
+
|
|
134
|
+
<dl>
|
|
135
|
+
<dd>
|
|
136
|
+
|
|
137
|
+
You can either:
|
|
138
|
+
|
|
139
|
+
1. Start a new task (auto creates a new simple session)
|
|
140
|
+
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
|
+
</dd>
|
|
142
|
+
</dl>
|
|
143
|
+
</dd>
|
|
144
|
+
</dl>
|
|
145
|
+
|
|
146
|
+
#### 🔌 Usage
|
|
147
|
+
|
|
148
|
+
<dl>
|
|
149
|
+
<dd>
|
|
150
|
+
|
|
151
|
+
<dl>
|
|
152
|
+
<dd>
|
|
153
|
+
|
|
154
|
+
```typescript
|
|
155
|
+
await client.tasks.createTask({
|
|
156
|
+
task: "task",
|
|
157
|
+
});
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
</dd>
|
|
161
|
+
</dl>
|
|
162
|
+
</dd>
|
|
163
|
+
</dl>
|
|
164
|
+
|
|
165
|
+
#### ⚙️ Parameters
|
|
166
|
+
|
|
167
|
+
<dl>
|
|
168
|
+
<dd>
|
|
169
|
+
|
|
170
|
+
<dl>
|
|
171
|
+
<dd>
|
|
172
|
+
|
|
173
|
+
**request:** `BrowserUse.CreateTaskRequest`
|
|
174
|
+
|
|
175
|
+
</dd>
|
|
176
|
+
</dl>
|
|
177
|
+
|
|
178
|
+
<dl>
|
|
179
|
+
<dd>
|
|
180
|
+
|
|
181
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
182
|
+
|
|
183
|
+
</dd>
|
|
184
|
+
</dl>
|
|
185
|
+
</dd>
|
|
186
|
+
</dl>
|
|
187
|
+
|
|
188
|
+
</dd>
|
|
189
|
+
</dl>
|
|
190
|
+
</details>
|
|
191
|
+
|
|
192
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getTask</a>(taskId) -> BrowserUse.TaskView</code></summary>
|
|
193
|
+
<dl>
|
|
194
|
+
<dd>
|
|
195
|
+
|
|
196
|
+
#### 📝 Description
|
|
197
|
+
|
|
198
|
+
<dl>
|
|
199
|
+
<dd>
|
|
200
|
+
|
|
201
|
+
<dl>
|
|
202
|
+
<dd>
|
|
203
|
+
|
|
204
|
+
Get detailed task information including status, progress, steps, and file outputs.
|
|
205
|
+
|
|
206
|
+
</dd>
|
|
207
|
+
</dl>
|
|
208
|
+
</dd>
|
|
209
|
+
</dl>
|
|
210
|
+
|
|
211
|
+
#### 🔌 Usage
|
|
212
|
+
|
|
213
|
+
<dl>
|
|
214
|
+
<dd>
|
|
215
|
+
|
|
216
|
+
<dl>
|
|
217
|
+
<dd>
|
|
218
|
+
|
|
219
|
+
```typescript
|
|
220
|
+
await client.tasks.getTask("task_id");
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
</dd>
|
|
224
|
+
</dl>
|
|
225
|
+
</dd>
|
|
226
|
+
</dl>
|
|
227
|
+
|
|
228
|
+
#### ⚙️ Parameters
|
|
229
|
+
|
|
230
|
+
<dl>
|
|
231
|
+
<dd>
|
|
232
|
+
|
|
233
|
+
<dl>
|
|
234
|
+
<dd>
|
|
235
|
+
|
|
236
|
+
**taskId:** `string`
|
|
237
|
+
|
|
238
|
+
</dd>
|
|
239
|
+
</dl>
|
|
240
|
+
|
|
241
|
+
<dl>
|
|
242
|
+
<dd>
|
|
243
|
+
|
|
244
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
245
|
+
|
|
246
|
+
</dd>
|
|
247
|
+
</dl>
|
|
248
|
+
</dd>
|
|
249
|
+
</dl>
|
|
250
|
+
|
|
251
|
+
</dd>
|
|
252
|
+
</dl>
|
|
253
|
+
</details>
|
|
254
|
+
|
|
255
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">updateTask</a>(taskId, { ...params }) -> BrowserUse.TaskView</code></summary>
|
|
256
|
+
<dl>
|
|
257
|
+
<dd>
|
|
258
|
+
|
|
259
|
+
#### 📝 Description
|
|
260
|
+
|
|
261
|
+
<dl>
|
|
262
|
+
<dd>
|
|
263
|
+
|
|
264
|
+
<dl>
|
|
265
|
+
<dd>
|
|
266
|
+
|
|
267
|
+
Control task execution with stop, pause, resume, or stop task and session actions.
|
|
268
|
+
|
|
269
|
+
</dd>
|
|
270
|
+
</dl>
|
|
271
|
+
</dd>
|
|
272
|
+
</dl>
|
|
273
|
+
|
|
274
|
+
#### 🔌 Usage
|
|
275
|
+
|
|
276
|
+
<dl>
|
|
277
|
+
<dd>
|
|
278
|
+
|
|
279
|
+
<dl>
|
|
280
|
+
<dd>
|
|
281
|
+
|
|
282
|
+
```typescript
|
|
283
|
+
await client.tasks.updateTask("task_id", {
|
|
284
|
+
action: "stop",
|
|
285
|
+
});
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
</dd>
|
|
289
|
+
</dl>
|
|
290
|
+
</dd>
|
|
291
|
+
</dl>
|
|
292
|
+
|
|
293
|
+
#### ⚙️ Parameters
|
|
294
|
+
|
|
295
|
+
<dl>
|
|
296
|
+
<dd>
|
|
297
|
+
|
|
298
|
+
<dl>
|
|
299
|
+
<dd>
|
|
300
|
+
|
|
301
|
+
**taskId:** `string`
|
|
302
|
+
|
|
303
|
+
</dd>
|
|
304
|
+
</dl>
|
|
305
|
+
|
|
306
|
+
<dl>
|
|
307
|
+
<dd>
|
|
308
|
+
|
|
309
|
+
**request:** `BrowserUse.UpdateTaskRequest`
|
|
310
|
+
|
|
311
|
+
</dd>
|
|
312
|
+
</dl>
|
|
313
|
+
|
|
314
|
+
<dl>
|
|
315
|
+
<dd>
|
|
316
|
+
|
|
317
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
318
|
+
|
|
319
|
+
</dd>
|
|
320
|
+
</dl>
|
|
321
|
+
</dd>
|
|
322
|
+
</dl>
|
|
323
|
+
|
|
324
|
+
</dd>
|
|
325
|
+
</dl>
|
|
326
|
+
</details>
|
|
327
|
+
|
|
328
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getTaskLogs</a>(taskId) -> BrowserUse.TaskLogFileResponse</code></summary>
|
|
329
|
+
<dl>
|
|
330
|
+
<dd>
|
|
331
|
+
|
|
332
|
+
#### 📝 Description
|
|
333
|
+
|
|
334
|
+
<dl>
|
|
335
|
+
<dd>
|
|
336
|
+
|
|
337
|
+
<dl>
|
|
338
|
+
<dd>
|
|
339
|
+
|
|
340
|
+
Get secure download URL for task execution logs with step-by-step details.
|
|
341
|
+
|
|
342
|
+
</dd>
|
|
343
|
+
</dl>
|
|
344
|
+
</dd>
|
|
345
|
+
</dl>
|
|
346
|
+
|
|
347
|
+
#### 🔌 Usage
|
|
348
|
+
|
|
349
|
+
<dl>
|
|
350
|
+
<dd>
|
|
351
|
+
|
|
352
|
+
<dl>
|
|
353
|
+
<dd>
|
|
354
|
+
|
|
355
|
+
```typescript
|
|
356
|
+
await client.tasks.getTaskLogs("task_id");
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
</dd>
|
|
360
|
+
</dl>
|
|
361
|
+
</dd>
|
|
362
|
+
</dl>
|
|
363
|
+
|
|
364
|
+
#### ⚙️ Parameters
|
|
365
|
+
|
|
366
|
+
<dl>
|
|
367
|
+
<dd>
|
|
368
|
+
|
|
369
|
+
<dl>
|
|
370
|
+
<dd>
|
|
371
|
+
|
|
372
|
+
**taskId:** `string`
|
|
373
|
+
|
|
374
|
+
</dd>
|
|
375
|
+
</dl>
|
|
376
|
+
|
|
377
|
+
<dl>
|
|
378
|
+
<dd>
|
|
379
|
+
|
|
380
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
381
|
+
|
|
382
|
+
</dd>
|
|
383
|
+
</dl>
|
|
384
|
+
</dd>
|
|
385
|
+
</dl>
|
|
386
|
+
|
|
387
|
+
</dd>
|
|
388
|
+
</dl>
|
|
389
|
+
</details>
|
|
390
|
+
|
|
391
|
+
## Sessions
|
|
392
|
+
|
|
393
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">listSessions</a>({ ...params }) -> BrowserUse.SessionListResponse</code></summary>
|
|
394
|
+
<dl>
|
|
395
|
+
<dd>
|
|
396
|
+
|
|
397
|
+
#### 📝 Description
|
|
398
|
+
|
|
399
|
+
<dl>
|
|
400
|
+
<dd>
|
|
401
|
+
|
|
402
|
+
<dl>
|
|
403
|
+
<dd>
|
|
404
|
+
|
|
405
|
+
Get paginated list of AI agent sessions with optional status filtering.
|
|
406
|
+
|
|
407
|
+
</dd>
|
|
408
|
+
</dl>
|
|
409
|
+
</dd>
|
|
410
|
+
</dl>
|
|
411
|
+
|
|
412
|
+
#### 🔌 Usage
|
|
413
|
+
|
|
414
|
+
<dl>
|
|
415
|
+
<dd>
|
|
416
|
+
|
|
417
|
+
<dl>
|
|
418
|
+
<dd>
|
|
419
|
+
|
|
420
|
+
```typescript
|
|
421
|
+
await client.sessions.listSessions();
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
</dd>
|
|
425
|
+
</dl>
|
|
426
|
+
</dd>
|
|
427
|
+
</dl>
|
|
428
|
+
|
|
429
|
+
#### ⚙️ Parameters
|
|
430
|
+
|
|
431
|
+
<dl>
|
|
432
|
+
<dd>
|
|
433
|
+
|
|
434
|
+
<dl>
|
|
435
|
+
<dd>
|
|
436
|
+
|
|
437
|
+
**request:** `BrowserUse.ListSessionsSessionsGetRequest`
|
|
438
|
+
|
|
439
|
+
</dd>
|
|
440
|
+
</dl>
|
|
441
|
+
|
|
442
|
+
<dl>
|
|
443
|
+
<dd>
|
|
444
|
+
|
|
445
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
446
|
+
|
|
447
|
+
</dd>
|
|
448
|
+
</dl>
|
|
449
|
+
</dd>
|
|
450
|
+
</dl>
|
|
451
|
+
|
|
452
|
+
</dd>
|
|
453
|
+
</dl>
|
|
454
|
+
</details>
|
|
455
|
+
|
|
456
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">createSession</a>({ ...params }) -> BrowserUse.SessionItemView</code></summary>
|
|
457
|
+
<dl>
|
|
458
|
+
<dd>
|
|
459
|
+
|
|
460
|
+
#### 📝 Description
|
|
461
|
+
|
|
462
|
+
<dl>
|
|
463
|
+
<dd>
|
|
464
|
+
|
|
465
|
+
<dl>
|
|
466
|
+
<dd>
|
|
467
|
+
|
|
468
|
+
Create a new session with a new task.
|
|
469
|
+
|
|
470
|
+
</dd>
|
|
471
|
+
</dl>
|
|
472
|
+
</dd>
|
|
473
|
+
</dl>
|
|
474
|
+
|
|
475
|
+
#### 🔌 Usage
|
|
476
|
+
|
|
477
|
+
<dl>
|
|
478
|
+
<dd>
|
|
479
|
+
|
|
480
|
+
<dl>
|
|
481
|
+
<dd>
|
|
482
|
+
|
|
483
|
+
```typescript
|
|
484
|
+
await client.sessions.createSession();
|
|
485
|
+
```
|
|
486
|
+
|
|
487
|
+
</dd>
|
|
488
|
+
</dl>
|
|
489
|
+
</dd>
|
|
490
|
+
</dl>
|
|
491
|
+
|
|
492
|
+
#### ⚙️ Parameters
|
|
493
|
+
|
|
494
|
+
<dl>
|
|
495
|
+
<dd>
|
|
496
|
+
|
|
497
|
+
<dl>
|
|
498
|
+
<dd>
|
|
499
|
+
|
|
500
|
+
**request:** `BrowserUse.CreateSessionRequest`
|
|
501
|
+
|
|
502
|
+
</dd>
|
|
503
|
+
</dl>
|
|
504
|
+
|
|
505
|
+
<dl>
|
|
506
|
+
<dd>
|
|
507
|
+
|
|
508
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
509
|
+
|
|
510
|
+
</dd>
|
|
511
|
+
</dl>
|
|
512
|
+
</dd>
|
|
513
|
+
</dl>
|
|
514
|
+
|
|
515
|
+
</dd>
|
|
516
|
+
</dl>
|
|
517
|
+
</details>
|
|
518
|
+
|
|
519
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getSession</a>(sessionId) -> BrowserUse.SessionView</code></summary>
|
|
520
|
+
<dl>
|
|
521
|
+
<dd>
|
|
522
|
+
|
|
523
|
+
#### 📝 Description
|
|
524
|
+
|
|
525
|
+
<dl>
|
|
526
|
+
<dd>
|
|
527
|
+
|
|
528
|
+
<dl>
|
|
529
|
+
<dd>
|
|
530
|
+
|
|
531
|
+
Get detailed session information including status, URLs, and task details.
|
|
532
|
+
|
|
533
|
+
</dd>
|
|
534
|
+
</dl>
|
|
535
|
+
</dd>
|
|
536
|
+
</dl>
|
|
537
|
+
|
|
538
|
+
#### 🔌 Usage
|
|
539
|
+
|
|
540
|
+
<dl>
|
|
541
|
+
<dd>
|
|
542
|
+
|
|
543
|
+
<dl>
|
|
544
|
+
<dd>
|
|
545
|
+
|
|
546
|
+
```typescript
|
|
547
|
+
await client.sessions.getSession("session_id");
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
</dd>
|
|
551
|
+
</dl>
|
|
552
|
+
</dd>
|
|
553
|
+
</dl>
|
|
554
|
+
|
|
555
|
+
#### ⚙️ Parameters
|
|
556
|
+
|
|
557
|
+
<dl>
|
|
558
|
+
<dd>
|
|
559
|
+
|
|
560
|
+
<dl>
|
|
561
|
+
<dd>
|
|
562
|
+
|
|
563
|
+
**sessionId:** `string`
|
|
564
|
+
|
|
565
|
+
</dd>
|
|
566
|
+
</dl>
|
|
567
|
+
|
|
568
|
+
<dl>
|
|
569
|
+
<dd>
|
|
570
|
+
|
|
571
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
572
|
+
|
|
573
|
+
</dd>
|
|
574
|
+
</dl>
|
|
575
|
+
</dd>
|
|
576
|
+
</dl>
|
|
577
|
+
|
|
578
|
+
</dd>
|
|
579
|
+
</dl>
|
|
580
|
+
</details>
|
|
581
|
+
|
|
582
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">deleteSession</a>(sessionId) -> void</code></summary>
|
|
583
|
+
<dl>
|
|
584
|
+
<dd>
|
|
585
|
+
|
|
586
|
+
#### 📝 Description
|
|
587
|
+
|
|
588
|
+
<dl>
|
|
589
|
+
<dd>
|
|
590
|
+
|
|
591
|
+
<dl>
|
|
592
|
+
<dd>
|
|
593
|
+
|
|
594
|
+
Permanently delete a session and all associated data.
|
|
595
|
+
|
|
596
|
+
</dd>
|
|
597
|
+
</dl>
|
|
598
|
+
</dd>
|
|
599
|
+
</dl>
|
|
600
|
+
|
|
601
|
+
#### 🔌 Usage
|
|
602
|
+
|
|
603
|
+
<dl>
|
|
604
|
+
<dd>
|
|
605
|
+
|
|
606
|
+
<dl>
|
|
607
|
+
<dd>
|
|
608
|
+
|
|
609
|
+
```typescript
|
|
610
|
+
await client.sessions.deleteSession("session_id");
|
|
611
|
+
```
|
|
612
|
+
|
|
613
|
+
</dd>
|
|
614
|
+
</dl>
|
|
615
|
+
</dd>
|
|
616
|
+
</dl>
|
|
617
|
+
|
|
618
|
+
#### ⚙️ Parameters
|
|
619
|
+
|
|
620
|
+
<dl>
|
|
621
|
+
<dd>
|
|
622
|
+
|
|
623
|
+
<dl>
|
|
624
|
+
<dd>
|
|
625
|
+
|
|
626
|
+
**sessionId:** `string`
|
|
627
|
+
|
|
628
|
+
</dd>
|
|
629
|
+
</dl>
|
|
630
|
+
|
|
631
|
+
<dl>
|
|
632
|
+
<dd>
|
|
633
|
+
|
|
634
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
635
|
+
|
|
636
|
+
</dd>
|
|
637
|
+
</dl>
|
|
638
|
+
</dd>
|
|
639
|
+
</dl>
|
|
640
|
+
|
|
641
|
+
</dd>
|
|
642
|
+
</dl>
|
|
643
|
+
</details>
|
|
644
|
+
|
|
645
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">updateSession</a>(sessionId, { ...params }) -> BrowserUse.SessionView</code></summary>
|
|
646
|
+
<dl>
|
|
647
|
+
<dd>
|
|
648
|
+
|
|
649
|
+
#### 📝 Description
|
|
650
|
+
|
|
651
|
+
<dl>
|
|
652
|
+
<dd>
|
|
653
|
+
|
|
654
|
+
<dl>
|
|
655
|
+
<dd>
|
|
656
|
+
|
|
657
|
+
Stop a session and all its running tasks.
|
|
658
|
+
|
|
659
|
+
</dd>
|
|
660
|
+
</dl>
|
|
661
|
+
</dd>
|
|
662
|
+
</dl>
|
|
663
|
+
|
|
664
|
+
#### 🔌 Usage
|
|
665
|
+
|
|
666
|
+
<dl>
|
|
667
|
+
<dd>
|
|
668
|
+
|
|
669
|
+
<dl>
|
|
670
|
+
<dd>
|
|
671
|
+
|
|
672
|
+
```typescript
|
|
673
|
+
await client.sessions.updateSession("session_id", {});
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
</dd>
|
|
677
|
+
</dl>
|
|
678
|
+
</dd>
|
|
679
|
+
</dl>
|
|
680
|
+
|
|
681
|
+
#### ⚙️ Parameters
|
|
682
|
+
|
|
683
|
+
<dl>
|
|
684
|
+
<dd>
|
|
685
|
+
|
|
686
|
+
<dl>
|
|
687
|
+
<dd>
|
|
688
|
+
|
|
689
|
+
**sessionId:** `string`
|
|
690
|
+
|
|
691
|
+
</dd>
|
|
692
|
+
</dl>
|
|
693
|
+
|
|
694
|
+
<dl>
|
|
695
|
+
<dd>
|
|
696
|
+
|
|
697
|
+
**request:** `BrowserUse.UpdateSessionRequest`
|
|
698
|
+
|
|
699
|
+
</dd>
|
|
700
|
+
</dl>
|
|
701
|
+
|
|
702
|
+
<dl>
|
|
703
|
+
<dd>
|
|
704
|
+
|
|
705
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
706
|
+
|
|
707
|
+
</dd>
|
|
708
|
+
</dl>
|
|
709
|
+
</dd>
|
|
710
|
+
</dl>
|
|
711
|
+
|
|
712
|
+
</dd>
|
|
713
|
+
</dl>
|
|
714
|
+
</details>
|
|
715
|
+
|
|
716
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getSessionPublicShare</a>(sessionId) -> BrowserUse.ShareView</code></summary>
|
|
717
|
+
<dl>
|
|
718
|
+
<dd>
|
|
719
|
+
|
|
720
|
+
#### 📝 Description
|
|
721
|
+
|
|
722
|
+
<dl>
|
|
723
|
+
<dd>
|
|
724
|
+
|
|
725
|
+
<dl>
|
|
726
|
+
<dd>
|
|
727
|
+
|
|
728
|
+
Get public share information including URL and usage statistics.
|
|
729
|
+
|
|
730
|
+
</dd>
|
|
731
|
+
</dl>
|
|
732
|
+
</dd>
|
|
733
|
+
</dl>
|
|
734
|
+
|
|
735
|
+
#### 🔌 Usage
|
|
736
|
+
|
|
737
|
+
<dl>
|
|
738
|
+
<dd>
|
|
739
|
+
|
|
740
|
+
<dl>
|
|
741
|
+
<dd>
|
|
742
|
+
|
|
743
|
+
```typescript
|
|
744
|
+
await client.sessions.getSessionPublicShare("session_id");
|
|
745
|
+
```
|
|
746
|
+
|
|
747
|
+
</dd>
|
|
748
|
+
</dl>
|
|
749
|
+
</dd>
|
|
750
|
+
</dl>
|
|
751
|
+
|
|
752
|
+
#### ⚙️ Parameters
|
|
753
|
+
|
|
754
|
+
<dl>
|
|
755
|
+
<dd>
|
|
756
|
+
|
|
757
|
+
<dl>
|
|
758
|
+
<dd>
|
|
759
|
+
|
|
760
|
+
**sessionId:** `string`
|
|
761
|
+
|
|
762
|
+
</dd>
|
|
763
|
+
</dl>
|
|
764
|
+
|
|
765
|
+
<dl>
|
|
766
|
+
<dd>
|
|
767
|
+
|
|
768
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
769
|
+
|
|
770
|
+
</dd>
|
|
771
|
+
</dl>
|
|
772
|
+
</dd>
|
|
773
|
+
</dl>
|
|
774
|
+
|
|
775
|
+
</dd>
|
|
776
|
+
</dl>
|
|
777
|
+
</details>
|
|
778
|
+
|
|
779
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">createSessionPublicShare</a>(sessionId) -> BrowserUse.ShareView</code></summary>
|
|
780
|
+
<dl>
|
|
781
|
+
<dd>
|
|
782
|
+
|
|
783
|
+
#### 📝 Description
|
|
784
|
+
|
|
785
|
+
<dl>
|
|
786
|
+
<dd>
|
|
787
|
+
|
|
788
|
+
<dl>
|
|
789
|
+
<dd>
|
|
790
|
+
|
|
791
|
+
Create or return existing public share for a session.
|
|
792
|
+
|
|
793
|
+
</dd>
|
|
794
|
+
</dl>
|
|
795
|
+
</dd>
|
|
796
|
+
</dl>
|
|
797
|
+
|
|
798
|
+
#### 🔌 Usage
|
|
799
|
+
|
|
800
|
+
<dl>
|
|
801
|
+
<dd>
|
|
802
|
+
|
|
803
|
+
<dl>
|
|
804
|
+
<dd>
|
|
805
|
+
|
|
806
|
+
```typescript
|
|
807
|
+
await client.sessions.createSessionPublicShare("session_id");
|
|
808
|
+
```
|
|
809
|
+
|
|
810
|
+
</dd>
|
|
811
|
+
</dl>
|
|
812
|
+
</dd>
|
|
813
|
+
</dl>
|
|
814
|
+
|
|
815
|
+
#### ⚙️ Parameters
|
|
816
|
+
|
|
817
|
+
<dl>
|
|
818
|
+
<dd>
|
|
819
|
+
|
|
820
|
+
<dl>
|
|
821
|
+
<dd>
|
|
822
|
+
|
|
823
|
+
**sessionId:** `string`
|
|
824
|
+
|
|
825
|
+
</dd>
|
|
826
|
+
</dl>
|
|
827
|
+
|
|
828
|
+
<dl>
|
|
829
|
+
<dd>
|
|
830
|
+
|
|
831
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
832
|
+
|
|
833
|
+
</dd>
|
|
834
|
+
</dl>
|
|
835
|
+
</dd>
|
|
836
|
+
</dl>
|
|
837
|
+
|
|
838
|
+
</dd>
|
|
839
|
+
</dl>
|
|
840
|
+
</details>
|
|
841
|
+
|
|
842
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">deleteSessionPublicShare</a>(sessionId) -> void</code></summary>
|
|
843
|
+
<dl>
|
|
844
|
+
<dd>
|
|
845
|
+
|
|
846
|
+
#### 📝 Description
|
|
847
|
+
|
|
848
|
+
<dl>
|
|
849
|
+
<dd>
|
|
850
|
+
|
|
851
|
+
<dl>
|
|
852
|
+
<dd>
|
|
853
|
+
|
|
854
|
+
Remove public share for a session.
|
|
855
|
+
|
|
856
|
+
</dd>
|
|
857
|
+
</dl>
|
|
858
|
+
</dd>
|
|
859
|
+
</dl>
|
|
860
|
+
|
|
861
|
+
#### 🔌 Usage
|
|
862
|
+
|
|
863
|
+
<dl>
|
|
864
|
+
<dd>
|
|
865
|
+
|
|
866
|
+
<dl>
|
|
867
|
+
<dd>
|
|
868
|
+
|
|
869
|
+
```typescript
|
|
870
|
+
await client.sessions.deleteSessionPublicShare("session_id");
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
</dd>
|
|
874
|
+
</dl>
|
|
875
|
+
</dd>
|
|
876
|
+
</dl>
|
|
877
|
+
|
|
878
|
+
#### ⚙️ Parameters
|
|
879
|
+
|
|
880
|
+
<dl>
|
|
881
|
+
<dd>
|
|
882
|
+
|
|
883
|
+
<dl>
|
|
884
|
+
<dd>
|
|
885
|
+
|
|
886
|
+
**sessionId:** `string`
|
|
887
|
+
|
|
888
|
+
</dd>
|
|
889
|
+
</dl>
|
|
890
|
+
|
|
891
|
+
<dl>
|
|
892
|
+
<dd>
|
|
893
|
+
|
|
894
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
895
|
+
|
|
896
|
+
</dd>
|
|
897
|
+
</dl>
|
|
898
|
+
</dd>
|
|
899
|
+
</dl>
|
|
900
|
+
|
|
901
|
+
</dd>
|
|
902
|
+
</dl>
|
|
903
|
+
</details>
|
|
904
|
+
|
|
905
|
+
## Files
|
|
906
|
+
|
|
907
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">userUploadFilePresignedUrl</a>(sessionId, { ...params }) -> BrowserUse.UploadFilePresignedUrlResponse</code></summary>
|
|
908
|
+
<dl>
|
|
909
|
+
<dd>
|
|
910
|
+
|
|
911
|
+
#### 📝 Description
|
|
912
|
+
|
|
913
|
+
<dl>
|
|
914
|
+
<dd>
|
|
915
|
+
|
|
916
|
+
<dl>
|
|
917
|
+
<dd>
|
|
918
|
+
|
|
919
|
+
Generate a secure presigned URL for uploading files that AI agents can use during tasks.
|
|
920
|
+
|
|
921
|
+
</dd>
|
|
922
|
+
</dl>
|
|
923
|
+
</dd>
|
|
924
|
+
</dl>
|
|
925
|
+
|
|
926
|
+
#### 🔌 Usage
|
|
927
|
+
|
|
928
|
+
<dl>
|
|
929
|
+
<dd>
|
|
930
|
+
|
|
931
|
+
<dl>
|
|
932
|
+
<dd>
|
|
933
|
+
|
|
934
|
+
```typescript
|
|
935
|
+
await client.files.userUploadFilePresignedUrl("session_id", {
|
|
936
|
+
fileName: "fileName",
|
|
937
|
+
contentType: "image/jpg",
|
|
938
|
+
sizeBytes: 1,
|
|
939
|
+
});
|
|
940
|
+
```
|
|
941
|
+
|
|
942
|
+
</dd>
|
|
943
|
+
</dl>
|
|
944
|
+
</dd>
|
|
945
|
+
</dl>
|
|
946
|
+
|
|
947
|
+
#### ⚙️ Parameters
|
|
948
|
+
|
|
949
|
+
<dl>
|
|
950
|
+
<dd>
|
|
951
|
+
|
|
952
|
+
<dl>
|
|
953
|
+
<dd>
|
|
954
|
+
|
|
955
|
+
**sessionId:** `string`
|
|
956
|
+
|
|
957
|
+
</dd>
|
|
958
|
+
</dl>
|
|
959
|
+
|
|
960
|
+
<dl>
|
|
961
|
+
<dd>
|
|
962
|
+
|
|
963
|
+
**request:** `BrowserUse.UploadFileRequest`
|
|
964
|
+
|
|
965
|
+
</dd>
|
|
966
|
+
</dl>
|
|
967
|
+
|
|
968
|
+
<dl>
|
|
969
|
+
<dd>
|
|
970
|
+
|
|
971
|
+
**requestOptions:** `Files.RequestOptions`
|
|
972
|
+
|
|
973
|
+
</dd>
|
|
974
|
+
</dl>
|
|
975
|
+
</dd>
|
|
976
|
+
</dl>
|
|
977
|
+
|
|
978
|
+
</dd>
|
|
979
|
+
</dl>
|
|
980
|
+
</details>
|
|
981
|
+
|
|
982
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">getTaskOutputFilePresignedUrl</a>(taskId, fileId) -> BrowserUse.TaskOutputFileResponse</code></summary>
|
|
983
|
+
<dl>
|
|
984
|
+
<dd>
|
|
985
|
+
|
|
986
|
+
#### 📝 Description
|
|
987
|
+
|
|
988
|
+
<dl>
|
|
989
|
+
<dd>
|
|
990
|
+
|
|
991
|
+
<dl>
|
|
992
|
+
<dd>
|
|
993
|
+
|
|
994
|
+
Get secure download URL for an output file generated by the AI agent.
|
|
995
|
+
|
|
996
|
+
</dd>
|
|
997
|
+
</dl>
|
|
998
|
+
</dd>
|
|
999
|
+
</dl>
|
|
1000
|
+
|
|
1001
|
+
#### 🔌 Usage
|
|
1002
|
+
|
|
1003
|
+
<dl>
|
|
1004
|
+
<dd>
|
|
1005
|
+
|
|
1006
|
+
<dl>
|
|
1007
|
+
<dd>
|
|
1008
|
+
|
|
1009
|
+
```typescript
|
|
1010
|
+
await client.files.getTaskOutputFilePresignedUrl("task_id", "file_id");
|
|
1011
|
+
```
|
|
1012
|
+
|
|
1013
|
+
</dd>
|
|
1014
|
+
</dl>
|
|
1015
|
+
</dd>
|
|
1016
|
+
</dl>
|
|
1017
|
+
|
|
1018
|
+
#### ⚙️ Parameters
|
|
1019
|
+
|
|
1020
|
+
<dl>
|
|
1021
|
+
<dd>
|
|
1022
|
+
|
|
1023
|
+
<dl>
|
|
1024
|
+
<dd>
|
|
1025
|
+
|
|
1026
|
+
**taskId:** `string`
|
|
1027
|
+
|
|
1028
|
+
</dd>
|
|
1029
|
+
</dl>
|
|
1030
|
+
|
|
1031
|
+
<dl>
|
|
1032
|
+
<dd>
|
|
1033
|
+
|
|
1034
|
+
**fileId:** `string`
|
|
1035
|
+
|
|
1036
|
+
</dd>
|
|
1037
|
+
</dl>
|
|
1038
|
+
|
|
1039
|
+
<dl>
|
|
1040
|
+
<dd>
|
|
1041
|
+
|
|
1042
|
+
**requestOptions:** `Files.RequestOptions`
|
|
1043
|
+
|
|
1044
|
+
</dd>
|
|
1045
|
+
</dl>
|
|
1046
|
+
</dd>
|
|
1047
|
+
</dl>
|
|
1048
|
+
|
|
1049
|
+
</dd>
|
|
1050
|
+
</dl>
|
|
1051
|
+
</details>
|
|
1052
|
+
|
|
1053
|
+
## Profiles
|
|
1054
|
+
|
|
1055
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">listProfiles</a>({ ...params }) -> BrowserUse.ProfileListResponse</code></summary>
|
|
1056
|
+
<dl>
|
|
1057
|
+
<dd>
|
|
1058
|
+
|
|
1059
|
+
#### 📝 Description
|
|
1060
|
+
|
|
1061
|
+
<dl>
|
|
1062
|
+
<dd>
|
|
1063
|
+
|
|
1064
|
+
<dl>
|
|
1065
|
+
<dd>
|
|
1066
|
+
|
|
1067
|
+
Get paginated list of profiles.
|
|
1068
|
+
|
|
1069
|
+
</dd>
|
|
1070
|
+
</dl>
|
|
1071
|
+
</dd>
|
|
1072
|
+
</dl>
|
|
1073
|
+
|
|
1074
|
+
#### 🔌 Usage
|
|
1075
|
+
|
|
1076
|
+
<dl>
|
|
1077
|
+
<dd>
|
|
1078
|
+
|
|
1079
|
+
<dl>
|
|
1080
|
+
<dd>
|
|
1081
|
+
|
|
1082
|
+
```typescript
|
|
1083
|
+
await client.profiles.listProfiles();
|
|
1084
|
+
```
|
|
1085
|
+
|
|
1086
|
+
</dd>
|
|
1087
|
+
</dl>
|
|
1088
|
+
</dd>
|
|
1089
|
+
</dl>
|
|
1090
|
+
|
|
1091
|
+
#### ⚙️ Parameters
|
|
1092
|
+
|
|
1093
|
+
<dl>
|
|
1094
|
+
<dd>
|
|
1095
|
+
|
|
1096
|
+
<dl>
|
|
1097
|
+
<dd>
|
|
1098
|
+
|
|
1099
|
+
**request:** `BrowserUse.ListProfilesProfilesGetRequest`
|
|
1100
|
+
|
|
1101
|
+
</dd>
|
|
1102
|
+
</dl>
|
|
1103
|
+
|
|
1104
|
+
<dl>
|
|
1105
|
+
<dd>
|
|
1106
|
+
|
|
1107
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
1108
|
+
|
|
1109
|
+
</dd>
|
|
1110
|
+
</dl>
|
|
1111
|
+
</dd>
|
|
1112
|
+
</dl>
|
|
1113
|
+
|
|
1114
|
+
</dd>
|
|
1115
|
+
</dl>
|
|
1116
|
+
</details>
|
|
1117
|
+
|
|
1118
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">createProfile</a>() -> BrowserUse.ProfileView</code></summary>
|
|
1119
|
+
<dl>
|
|
1120
|
+
<dd>
|
|
1121
|
+
|
|
1122
|
+
#### 📝 Description
|
|
1123
|
+
|
|
1124
|
+
<dl>
|
|
1125
|
+
<dd>
|
|
1126
|
+
|
|
1127
|
+
<dl>
|
|
1128
|
+
<dd>
|
|
1129
|
+
|
|
1130
|
+
Profiles allow you to preserve the state of the browser between tasks.
|
|
1131
|
+
|
|
1132
|
+
They are most commonly used to allow users to preserve the log-in state in the agent between tasks.
|
|
1133
|
+
You'd normally create one profile per user and then use it for all their tasks.
|
|
1134
|
+
|
|
1135
|
+
You can create a new profile by calling this endpoint.
|
|
1136
|
+
|
|
1137
|
+
</dd>
|
|
1138
|
+
</dl>
|
|
1139
|
+
</dd>
|
|
1140
|
+
</dl>
|
|
1141
|
+
|
|
1142
|
+
#### 🔌 Usage
|
|
1143
|
+
|
|
1144
|
+
<dl>
|
|
1145
|
+
<dd>
|
|
1146
|
+
|
|
1147
|
+
<dl>
|
|
1148
|
+
<dd>
|
|
1149
|
+
|
|
1150
|
+
```typescript
|
|
1151
|
+
await client.profiles.createProfile();
|
|
1152
|
+
```
|
|
1153
|
+
|
|
1154
|
+
</dd>
|
|
1155
|
+
</dl>
|
|
1156
|
+
</dd>
|
|
1157
|
+
</dl>
|
|
1158
|
+
|
|
1159
|
+
#### ⚙️ Parameters
|
|
1160
|
+
|
|
1161
|
+
<dl>
|
|
1162
|
+
<dd>
|
|
1163
|
+
|
|
1164
|
+
<dl>
|
|
1165
|
+
<dd>
|
|
1166
|
+
|
|
1167
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
1168
|
+
|
|
1169
|
+
</dd>
|
|
1170
|
+
</dl>
|
|
1171
|
+
</dd>
|
|
1172
|
+
</dl>
|
|
1173
|
+
|
|
1174
|
+
</dd>
|
|
1175
|
+
</dl>
|
|
1176
|
+
</details>
|
|
1177
|
+
|
|
1178
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">getProfile</a>(profileId) -> BrowserUse.ProfileView</code></summary>
|
|
1179
|
+
<dl>
|
|
1180
|
+
<dd>
|
|
1181
|
+
|
|
1182
|
+
#### 📝 Description
|
|
1183
|
+
|
|
1184
|
+
<dl>
|
|
1185
|
+
<dd>
|
|
1186
|
+
|
|
1187
|
+
<dl>
|
|
1188
|
+
<dd>
|
|
1189
|
+
|
|
1190
|
+
Get profile details.
|
|
1191
|
+
|
|
1192
|
+
</dd>
|
|
1193
|
+
</dl>
|
|
1194
|
+
</dd>
|
|
1195
|
+
</dl>
|
|
1196
|
+
|
|
1197
|
+
#### 🔌 Usage
|
|
1198
|
+
|
|
1199
|
+
<dl>
|
|
1200
|
+
<dd>
|
|
1201
|
+
|
|
1202
|
+
<dl>
|
|
1203
|
+
<dd>
|
|
1204
|
+
|
|
1205
|
+
```typescript
|
|
1206
|
+
await client.profiles.getProfile("profile_id");
|
|
1207
|
+
```
|
|
1208
|
+
|
|
1209
|
+
</dd>
|
|
1210
|
+
</dl>
|
|
1211
|
+
</dd>
|
|
1212
|
+
</dl>
|
|
1213
|
+
|
|
1214
|
+
#### ⚙️ Parameters
|
|
1215
|
+
|
|
1216
|
+
<dl>
|
|
1217
|
+
<dd>
|
|
1218
|
+
|
|
1219
|
+
<dl>
|
|
1220
|
+
<dd>
|
|
1221
|
+
|
|
1222
|
+
**profileId:** `string`
|
|
1223
|
+
|
|
1224
|
+
</dd>
|
|
1225
|
+
</dl>
|
|
1226
|
+
|
|
1227
|
+
<dl>
|
|
1228
|
+
<dd>
|
|
1229
|
+
|
|
1230
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
1231
|
+
|
|
1232
|
+
</dd>
|
|
1233
|
+
</dl>
|
|
1234
|
+
</dd>
|
|
1235
|
+
</dl>
|
|
1236
|
+
|
|
1237
|
+
</dd>
|
|
1238
|
+
</dl>
|
|
1239
|
+
</details>
|
|
1240
|
+
|
|
1241
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">deleteBrowserProfile</a>(profileId) -> void</code></summary>
|
|
1242
|
+
<dl>
|
|
1243
|
+
<dd>
|
|
1244
|
+
|
|
1245
|
+
#### 📝 Description
|
|
1246
|
+
|
|
1247
|
+
<dl>
|
|
1248
|
+
<dd>
|
|
1249
|
+
|
|
1250
|
+
<dl>
|
|
1251
|
+
<dd>
|
|
1252
|
+
|
|
1253
|
+
Permanently delete a browser profile and its configuration.
|
|
1254
|
+
|
|
1255
|
+
</dd>
|
|
1256
|
+
</dl>
|
|
1257
|
+
</dd>
|
|
1258
|
+
</dl>
|
|
1259
|
+
|
|
1260
|
+
#### 🔌 Usage
|
|
1261
|
+
|
|
1262
|
+
<dl>
|
|
1263
|
+
<dd>
|
|
1264
|
+
|
|
1265
|
+
<dl>
|
|
1266
|
+
<dd>
|
|
1267
|
+
|
|
1268
|
+
```typescript
|
|
1269
|
+
await client.profiles.deleteBrowserProfile("profile_id");
|
|
1270
|
+
```
|
|
1271
|
+
|
|
1272
|
+
</dd>
|
|
1273
|
+
</dl>
|
|
1274
|
+
</dd>
|
|
1275
|
+
</dl>
|
|
1276
|
+
|
|
1277
|
+
#### ⚙️ Parameters
|
|
1278
|
+
|
|
1279
|
+
<dl>
|
|
1280
|
+
<dd>
|
|
1281
|
+
|
|
1282
|
+
<dl>
|
|
1283
|
+
<dd>
|
|
1284
|
+
|
|
1285
|
+
**profileId:** `string`
|
|
1286
|
+
|
|
1287
|
+
</dd>
|
|
1288
|
+
</dl>
|
|
1289
|
+
|
|
1290
|
+
<dl>
|
|
1291
|
+
<dd>
|
|
1292
|
+
|
|
1293
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
1294
|
+
|
|
1295
|
+
</dd>
|
|
1296
|
+
</dl>
|
|
1297
|
+
</dd>
|
|
1298
|
+
</dl>
|
|
1299
|
+
|
|
1300
|
+
</dd>
|
|
1301
|
+
</dl>
|
|
1302
|
+
</details>
|