POST
/
browser-profiles
JavaScript
import BrowserUse from 'browser-use-sdk';

const client = new BrowserUse({
  apiKey: 'My API Key',
});

const browserProfileView = await client.browserProfiles.create({ name: 'x' });

console.log(browserProfileView.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "persist": true,
  "adBlocker": true,
  "proxy": true,
  "proxyCountryCode": "us",
  "storeCache": true,
  "browserViewportWidth": 123,
  "browserViewportHeight": 123,
  "isMobile": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Browser-Use-API-Key
string
header
required

Body

application/json

Request model for creating a new browser profile

Attributes: name: Display name for the profile description: Optional description of the profile persist: Whether browser state should persist between sessions ad_blocker: Whether ad blocking is enabled proxy: Whether proxy is enabled proxy_country_code: Country code for proxy location store_cache: Whether to store browser cache browser_viewport_width: Browser viewport width in pixels browser_viewport_height: Browser viewport height in pixels is_mobile: Whether the browser should be in mobile view

Response

201
application/json

Successful Response

View model for representing a browser profile

Attributes: id: Unique identifier for the profile name: Display name for the profile description: Optional description of the profile persist: Whether browser state should persist between sessions ad_blocker: Whether ad blocking is enabled proxy: Whether proxy is enabled proxy_country_code: Country code for proxy location store_cache: Whether to store browser cache browser_viewport_width: Browser viewport width in pixels browser_viewport_height: Browser viewport height in pixels is_mobile: Whether the browser should be in mobile view created_at: Timestamp when the profile was created updated_at: Timestamp when the profile was last updated