Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.driver.dev/llms.txt

Use this file to discover all available pages before exploring further.

Browser profiles let you save and restore browser state (cookies, localStorage, login sessions) across multiple sessions.

How Profiles Work

  1. Create a session with a named profile
  2. Browser state is saved when the session stops
  3. Create a new session with the same profile name
  4. Browser loads with previous state intact

Creating a Session with a Profile

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

// Do your automation...
// Browser state will be saved when session stops

List All Profiles

Retrieve all saved browser profiles:
const profiles = await client.browser.profiles.list();

console.log(profiles);

Response

{
  "profiles": [
    {
      "profileId": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "name": "my-profile",
      "createdAt": "2025-12-19T18:58:03.000Z"
    }
  ]
}

Delete a Profile

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

console.log(result);

Response

{
  "success": true
}

Profile Parameters

ParameterTypeDescription
namestringUnique identifier for the profile
persistbooleanSet to true to save state when session stops

Notes

  • Profile names must be unique per account
  • Deleting a profile permanently removes all saved state
  • Sessions with persist: false don’t save state changes