Browser Profiles

View as Markdown

Browser profiles are persistent browser identities — saved cookies, local storage, and browser fingerprints that survive across runtime restarts. Use them when you need a runtime to “remember” logged-in sessions.

Access via bctrl.browserProfiles.

list()

List all browser profiles in your organization.

1const profiles = await bctrl.browserProfiles.list();

Returns BrowserProfile[]


create(request)

Create a new browser profile.

1const profile = await bctrl.browserProfiles.create({
2 name: "sales-bot",
3 description: "Salesforce automation profile",
4});
ParameterTypeRequiredDescription
namestringYesProfile name
descriptionstringNoHuman-readable description

Returns BrowserProfileDetail


get(id)

Get a specific profile by ID.

1const profile = await bctrl.browserProfiles.get("prof_abc123");
ParameterTypeRequiredDescription
idstringYesProfile ID

Returns BrowserProfileDetail


update(id, request)

Update a profile’s metadata.

1await bctrl.browserProfiles.update("prof_abc123", {
2 description: "Updated description",
3});
ParameterTypeRequiredDescription
idstringYesProfile ID
requestBrowserProfileUpdateRequestYesFields to update

Returns BrowserProfileDetail


delete(id)

Delete a profile and all its saved state.

1await bctrl.browserProfiles.delete("prof_abc123");
ParameterTypeRequiredDescription
idstringYesProfile ID

Usage with runtimes

Launch a runtime with a profile to use its saved state:

1const runtime = await workspace.runtimes.browser("crm").playwright({
2 mode: "profile",
3 profileId: "sales-bot",
4});
5
6// The browser starts with the profile's saved cookies and storage
7await runtime.page.goto("https://crm.example.com");
8// Already logged in if the session was saved

When the runtime stops, the profile state is saved automatically.