For AI agents: a documentation index is available at /llms.txt
Skip to main content

/profile

POST 

/profile

Launches a temporary browser session for creating an authenticated profile. Connect via the returned WebSocket URL, authenticate in the browser, then call Browserless.saveProfile via CDP to capture and persist the auth state. The profile is NOT saved automatically — you must explicitly call Browserless.saveProfile before disconnecting. The session expires after 10 minutes or your plan's session limit, whichever comes first. Free sessions are capped at two minutes; higher-tier plans retain the 10-minute maximum.

Note: This endpoint is also available at: /management/profile for backwards compatibility.

Request​

Query Parameters

    emulationOs Platform

    Possible values: [android, ios, linux, macos, windows]

    timeout number

Body

    namestringrequired

    A user-visible name for the profile. Must be unique per token.

    stealthboolean

    Whether or not to enable advanced stealth mode. Defaults to false.

    browserstring

    The type of browser to use. Defaults to 'stealth'.

    Possible values: [chrome, chromium, stealth]

    argsstring[]

    An array of command-line arguments to pass to the browser.

    proxy object

    Proxy parameters for the profile creation session.

    typestring

    The type of proxy to use: 'residential' or 'datacenter'.

    Possible values: [datacenter, residential]

    stickyboolean

    Whether or not to use the same IP address for all proxied requests. Defaults to true.

    countrystring

    The country to proxy through. Defaults to 'us' or United States.

    citystring

    The city to proxy through.

    statestring

    The state to proxy through.

    presetstring

    Preset code for website-specific proxy configurations (e.g., 'px_gov01' for government sites).

    integrationIdstring

    Optional 1Password integration id (op_int_…) or label. The profile-authoring session can fill credentials via Browserless.loadSecret.

    credentials object

    Optional alias → op:// reference map for the integration above.

    property name*string
    allowedDomainsstring[]

    Optional per-session narrowing of the integration's allowed domains.

    credentialOrigins object

    Optional alias → origins map. When set, each credential alias may only be filled on its own origins and unlisted aliases are refused.

    property name* string[]
  • Array [
  • string
  • ]

Responses​

Schema
    idstringrequired

    Temporary session ID used for the profile creation browser

    namestringrequired

    The profile name that will be used when saving

    connectstringrequired

    WebSocket URL to connect to the browser

    stopstringrequired

    URL to stop/delete the temporary session

Was this page helpful?