Get Browser Profiles

curl -X GET "https://browsepilot.ai/api/profiles" \
  -H "x-api-key: your-workspace-id"

const response = await fetch("https://browsepilot.ai/api/profiles", {
  method: "GET",
  headers: {
    "x-api-key": process.env.BROWSEPILOT_API_KEY,
  },
});

const profiles = await response.json();
console.log("Available profiles:", profiles.length);

import requests

response = requests.get(
    'https://browsepilot.ai/api/profiles',
    headers={
        'x-api-key': 'your-workspace-id'
    }
)

profiles = response.json()
print(f"Found {len(profiles)} profiles")

[
  {
    "id": "profile_abc123xyz",
    "name": "Personal Browser",
    "workspaceId": "workspace_456def",
    "description": "Profile for personal browsing and social media",
    "settings": {
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
      "viewport": {
        "width": 1920,
        "height": 1080
      },
      "proxy": null
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T14:45:00.000Z"
  },
  {
    "id": "profile_def456abc",
    "name": "Work Account",
    "workspaceId": "workspace_456def",
    "description": "Profile for work-related automation",
    "settings": {
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
      "viewport": {
        "width": 1440,
        "height": 900
      },
      "proxy": "http://corporate-proxy:8080"
    },
    "createdAt": "2024-01-10T08:15:00.000Z",
    "updatedAt": "2024-01-18T12:30:00.000Z"
  }
]

[]

{
  "error": "Unauthorized"
}

GET /api/profiles

Retrieve all browser profiles associated with your workspace. Browser profiles allow you to maintain separate browser identities with unique cookies, settings, and configurations.

Headers

string

required

Your workspace ID from Browsepilot Settings → Advanced

Response

Returns an array of browser profile objects.

array

Array of browser profile objects

Show Profile Object

string

Unique identifier for the browser profile

string

Human-readable name of the profile

string

ID of the workspace this profile belongs to

string

Optional description of the profile’s purpose

object

Browser configuration settings

Show Settings Object

string

Custom user agent string

object

Browser viewport configuration

Show Viewport Object

number

Viewport width in pixels

number

Viewport height in pixels

string

Proxy server configuration (if any)

string

ISO timestamp when the profile was created

string

ISO timestamp when the profile was last modified

curl -X GET "https://browsepilot.ai/api/profiles" \
  -H "x-api-key: your-workspace-id"

const response = await fetch("https://browsepilot.ai/api/profiles", {
  method: "GET",
  headers: {
    "x-api-key": process.env.BROWSEPILOT_API_KEY,
  },
});

const profiles = await response.json();
console.log("Available profiles:", profiles.length);

import requests

response = requests.get(
    'https://browsepilot.ai/api/profiles',
    headers={
        'x-api-key': 'your-workspace-id'
    }
)

profiles = response.json()
print(f"Found {len(profiles)} profiles")

[
  {
    "id": "profile_abc123xyz",
    "name": "Personal Browser",
    "workspaceId": "workspace_456def",
    "description": "Profile for personal browsing and social media",
    "settings": {
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
      "viewport": {
        "width": 1920,
        "height": 1080
      },
      "proxy": null
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T14:45:00.000Z"
  },
  {
    "id": "profile_def456abc",
    "name": "Work Account",
    "workspaceId": "workspace_456def",
    "description": "Profile for work-related automation",
    "settings": {
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
      "viewport": {
        "width": 1440,
        "height": 900
      },
      "proxy": "http://corporate-proxy:8080"
    },
    "createdAt": "2024-01-10T08:15:00.000Z",
    "updatedAt": "2024-01-18T12:30:00.000Z"
  }
]

[]

{
  "error": "Unauthorized"
}

Using Profiles in Conversations

Once you have profile IDs, use them when starting conversations:

// First, get available profiles
const profilesResponse = await fetch("https://browsepilot.ai/api/profiles", {
  headers: { "x-api-key": apiKey },
});
const profiles = await profilesResponse.json();

// Use a specific profile for automation
const workProfile = profiles.find((p) => p.name === "Work Account");

// Start conversation with that profile
const chatResponse = await fetch("https://browsepilot.ai/api/chat", {
  method: "POST",
  headers: {
    "x-api-key": apiKey,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    prompt: "Check my LinkedIn messages",
    profileId: workProfile.id,
  }),
});

Profile Benefits: - Isolation: Keep different accounts and cookies separate - Consistency: Maintain same fingerprint across sessions - Efficiency: Pre-configured settings reduce setup time - Organization: Easily manage multiple use cases

Error Handling

Status Code	Error	Description
`401`	Unauthorized	Missing or invalid `x-api-key` header
`404`	Unauthorized	Workspace not found for provided API key
`500`	Internal server error	Unexpected server error occurred

Profile Management

Currently, browser profiles must be created through the Browsepilot dashboard. API endpoints for creating and managing profiles programmatically are coming soon. To create profiles:

Open Browsepilot Dashboard
Click the Manage button
Click New Profile
Configure settings and save

API documentation

Endpoints

GET /api/profiles

Headers

Response

Using Profiles in Conversations

Error Handling

Profile Management

​GET /api/profiles

​Headers

​Response

​Using Profiles in Conversations

​Error Handling

​Profile Management

GET /api/profiles

Headers

Response

Using Profiles in Conversations

Error Handling

Profile Management