/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
Possible values: [android, ios, linux, macos, windows]
Body
- Schema
- Example (auto)
- Array [
- ]
A user-visible name for the profile. Must be unique per token.
Whether or not to enable advanced stealth mode. Defaults to false.
The type of browser to use. Defaults to 'stealth'.
Possible values: [chrome, chromium, stealth]
An array of command-line arguments to pass to the browser.
proxy object
Proxy parameters for the profile creation session.
The type of proxy to use: 'residential' or 'datacenter'.
Possible values: [datacenter, residential]
Whether or not to use the same IP address for all proxied requests. Defaults to true.
The country to proxy through. Defaults to 'us' or United States.
The city to proxy through.
The state to proxy through.
Preset code for website-specific proxy configurations (e.g., 'px_gov01' for government sites).
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.
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[]
{
"name": "string",
"stealth": true,
"browser": "chrome",
"args": [
"string"
],
"proxy": {
"type": "datacenter",
"sticky": true,
"country": "string",
"city": "string",
"state": "string",
"preset": "string"
},
"integrationId": "string",
"credentials": {},
"allowedDomains": [
"string"
],
"credentialOrigins": {}
}
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 429
- 500
- 503
Schema
- Fields
- Example (auto)
Temporary session ID used for the profile creation browser
The profile name that will be used when saving
WebSocket URL to connect to the browser
URL to stop/delete the temporary session
{
"id": "string",
"name": "string",
"connect": "string",
"stop": "string"
}
The request contains errors or didn't properly encode content.
The request is missing, or contains bad, authorization credentials.
The request targets a destination that is not allowed.
Resource couldn't be found.
The request took has taken too long to process.
Too many requests are currently being processed.
An internal error occurred when handling the request.
Service is unavailable.