The operation retrieves the list of workspaces accessible to the current user. This information is required to execute most subsequent queries.

This method provides functionality for filtering, sorting, and paginating proxies. It can filter results by workspace ID, folder ID, proxy ID, name, and sorting criteria. If parameters are not specified, the response returns the default page of proxies in standard order.

This method is used to add a new proxy entry using the provided configuration parameters. It returns the generated unique identifier.

This method processes an array of proxy data and creates all specified proxies. Errors during creation of individual proxies are ignored.

This method modifies configuration of an existing proxy server based on specified parameters. Any parameters set to null will leave the corresponding property of the proxy unchanged.

This method deletes a proxy from the list by the specified ID. The proxyId value must match an existing proxy in the specified workspace.

This method sends a bulk delete request to the API to remove the specified proxies. Ensure that the provided proxy IDs are valid and exist in the specified workspace.

This endpoint triggers an IP change for the specified mobile proxy. The proxy must have a valid IP change URL configured.

This method is used to get the list of proxy folders. It supports filtering, sorting, and pagination in returned results. Optional query parameters can be used to refine the result set. If parameters are not specified, the method returns the first page of proxy folders in the default sorting order.

This method creates a new proxy folder. The caller must ensure that the specified workspace ID and location are valid. Proxy folder is container for proxies and is used for better organization. Each folder has a unique identifier that is returned upon creation and can be used for subsequent operations on the folder, such as updating or deleting.

This method updates the name of the specified proxy folder. This is the only editable property.

This method deletes a proxy folder. The parameter proxyFolderId must match the existing folder within the specified workspace.

This method deletes a proxy folder and all proxies it contains. The parameter proxyFolderId must match the existing folder within the specified workspace.

This method retrieves a list of folders available in the specified workspace. Optionally, it is possible to limit the number of results, specify filters, or define sorting conditions. If no parameters are specified, the method returns the first page of profile folders in the default order.

This method creates a profile folder. The caller must ensure that the specified workspace ID and location are valid. Profile folders are contained within workspaces and can be used to organize browser profiles. Each folder has a unique identifier, a name, a location (Local or Cloud), and a quantity representing the number of profiles it contains. Profile folders count is limited by tariff.

This method can be used to update the profile folder name.

This method is used for deleting a profile folder. The profileFolderId value must match the existing folder in the specified workspace.

This method deletes a profile folder and all profiles it contains. The profileFolderId value must match the existing folder in the specified workspace.

This method retrieves a list of profiles with their attributes from the specified workspace and the folder. It is possible to optionally filter results by ID, name, tags, and sorting.

This method creates a new browser profile in the specified workspace and the folder. It is possible to customize various parameters such as screen size, hardware emulation, language, timezone, proxy, and others. All parameters are optional if another is not specified. Browser profile is a set of parameters for browser configuration that can be used to create browser instances with different fingerprints and settings. Each profile has a unique identifier that is returned upon creation and can be used for subsequent operations on the profile, such as updating or deleting.

This method is used to create new multiple browser profiles in the specified workspace and the folder. Each profile can have its own configuration, including screen size, hardware emulation, language, timezone, proxy, and other parameters. All fields are optional if another is not specified.

This method updates an existing browser profile.

This method deletes an existing browser profile.

This method is used to delete several existing browser profiles at once.

This method allows importing cookies into an existing profile in JSON format. Ensure that the cookies parameter is a valid JSON value representing the cookies to be imported. Cookies will overwrite existing cookies in the profile.

This method allows exporting cookies from an existing profile in JSON format. The exported cookies can be used for backup or transfer purposes.

Copies cookies from source profile to target profile. Cookies in the target profile will be overwritten.

Retrieves detailed information about a specific Browser Profile

This method can be used to recover a browser profile that is in an invalid state in the specified workspace. Most common use case is to recover a profile that is crashed or corrupted due to a machine failure.

This method can be used to force unlock a cloud browser profile that is currently locked by another machine in the specified workspace.

This method can be used to clean up cached data for a browser profile in the specified workspace.

This method moves one or more browser profiles to the specified target folder within the workspace.

This method updates the preset configuration for one or more browser profiles at once.

This method updates the proxy settings for one or more browser profiles at once. You can either set a specific proxy server or assign proxies from a container.

This method updates the tags for one or more browser profiles at once.

This method starts the cookie robot for the specified browser profiles. The robot opens each profile's browser and visits the provided URLs to collect cookies.

Retrieves per-profile status of a previously started script run.

Retrieves extensions accessible to the current user.

Adds a web extension to the specified preset.

Adds a file extension to the specified preset.

Deletes an extension.

Retrieves presets accessible to the current user.

Creates a new preset. Presets are used to group extensions, bookmarks, manage them together and assign them to profiles. All presets are cloud-based.

Deletes a preset.

This method retrieves the list of execution threads for the specified workspace. Threads can be filtered by token or type, limited by the number of results, and sorted using the provided parameters.

This method runs a new execution thread in the specified workspace. Execution threads are used to start, work with a browser instance. They can be manually continued with the continue_use_thread method or stopped with the stop_thread method.

This method can be used to start execution threads in bulk for the specified workspace.

This method is used to continue work of the execution thread associated with the thread token.

This method is used to update the specified execution threads, allowing them to continue working. The threadTokens parameter should contain the array of valid tokens with existing workspace IDs.

This method can be used to stop an existing execution thread. Stopping a thread will also stop the associated browser instance, if it exists.

This method stops multiple execution threads.

This method returns the list of browser processes available for the current user with detailed information. Results can be filtered by profile ID or process ID, optionally sorted, and limited by the number of returned entries. Important: these actions are applied only to browser instances launched via the API.

This method creates the new browser instance using the specified profile with optional workspace and desktop settings.

Throws if no browser instance is currently running for the given profile.

This method is used to create browser instances in bulk for the specified profiles. Ensure that the provided profile IDs are valid and that the specified workspace ID exists.

This method stops the existing browser instance associated with the specified profile. This operation permanently closes the browser instance and releases all associated resources.

This method stops multiple existing browser instances associated with the specified profiles. This operation permanently closes all specified browser instances and releases their resources.

Bring the browser window of the specified profile to the foreground

Set browser instance window visibility (show or hide). This method works only for browser instances launched via the API with reveal or conceal options.

This method returns the current version of the product.

This method returns the current version of the browser engine.

This method returns the current limits for the specified workspace.

This method returns the current tariff for the specified workspace.