Skip to main content
Browser profiles save cookies and browser state so later sessions can reuse the same login or site state.
Profiles are supported on hosted sessions. Use type: "hosted" when creating a session with a profile.

Create a Session with a Profile

const session = await client.browser.session.create({
  type: "hosted",
  profile: {
    name: "my-profile",
    persist: true,
  },
});

Profile Parameters

ParameterTypeDescription
namestringRequired profile name. Reuse this name to load the same profile later.
persistbooleanSave profile changes when the session stops.

List Profiles

const { profiles } = await client.browser.profiles.list();

Delete a Profile

const result = await client.browser.profiles.delete({
  profileName: "my-profile",
});