Skip to main content
POST
/
browser
/
custom
Create profile with partial parameters
curl --request POST \
  --url https://api.gologin.com/browser/custom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My Test Profile",
  "notes": "Temporary profile for testing",
  "autoLang": true,
  "lockEnabled": false,
  "folderName": "<string>",
  "bookmarks": {
    "BookmarkName": {
      "bookmarks_bar": {
        "name": "Bookmark Name",
        "type": "folder",
        "children": [
          {
            "name": "Bookmark Name",
            "type": "url",
            "url": "https://www.google.com"
          }
        ]
      }
    }
  },
  "os": "win",
  "osSpec": "win11",
  "devicePixelRatio": 1,
  "navigator": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.6998.36 Safari/537.36",
    "resolution": "1920x1080",
    "language": "en-US",
    "platform": "Win32",
    "hardwareConcurrency": 4,
    "deviceMemory": 4,
    "maxTouchPoints": 10
  },
  "proxy": {
    "id": "6201422450e3b9cd602f24e1",
    "mode": "http",
    "host": "127.0.0.1",
    "port": 80,
    "username": "user",
    "password": "password",
    "changeIpUrl": "https://some-proxy-provider.com/change-ip",
    "customName": "My Proxy"
  },
  "dns": "8.8.8.8",
  "timezone": {
    "enabled": true,
    "fillBasedOnIp": true,
    "timezone": "America/New_York"
  },
  "geolocation": {
    "mode": "prompt",
    "enabled": true,
    "customize": true,
    "fillBasedOnIp": true,
    "isCustomCoordinates": true,
    "latitude": 123,
    "longitude": 123,
    "accuracy": 123
  },
  "audioContext": {
    "mode": "noise",
    "noise": 0.1
  },
  "canvas": {
    "mode": "off",
    "noise": 0.1
  },
  "fonts": {
    "families": [
      "Arial",
      "Helvetica",
      "Verdana"
    ],
    "enableMasking": true,
    "enableDomRect": true
  },
  "mediaDevices": {
    "videoInputs": 1,
    "audioInputs": 1,
    "audioOutputs": 1,
    "enableMasking": false,
    "uid": "<string>"
  },
  "webRTC": {
    "enable": true,
    "isEmptyIceList": true,
    "mode": "off"
  },
  "webGL": {
    "mode": "noise",
    "getClientRectsNoise": 0.5,
    "noise": 0.5
  },
  "clientRects": {
    "mode": "noise",
    "noise": 0.5
  },
  "webGLMetadata": {
    "mode": "mask",
    "vendor": "Google Inc. (Intel)",
    "renderer": "ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)"
  },
  "chromeExtensions": [],
  "userChromeExtensions": [],
  "folders": []
}'
{
  "name": "<string>",
  "role": "<string>",
  "id": "<string>",
  "notes": "<string>",
  "browserType": "<string>",
  "lockEnabled": true,
  "timezone": {},
  "navigator": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.6998.36 Safari/537.36",
    "resolution": "1920x1080",
    "language": "en-US",
    "platform": "Win32",
    "hardwareConcurrency": 4,
    "deviceMemory": 4,
    "maxTouchPoints": 10
  },
  "geolocation": {},
  "debugMode": true,
  "isM1": true,
  "isPinned": true,
  "updateUALastChosenBrowserV": "<string>",
  "canBeRunning": true,
  "isRunDisabled": true,
  "runDisabledReason": "unpaid-share",
  "isRunning": true,
  "isWeb": true,
  "os": {},
  "osSpec": {},
  "proxy": {},
  "host": "<string>",
  "port": 123,
  "proxyType": "<string>",
  "proxyRegion": "<string>",
  "status": "<string>",
  "folders": [
    "<string>"
  ],
  "sharedEmails": [
    "<string>"
  ],
  "shareId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastActivity": "2023-11-07T05:31:56Z",
  "chromeExtensions": [
    "<string>"
  ],
  "userChromeExtensions": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "permissions": {
    "transferProfile": true,
    "transferToMyWorkspace": true,
    "shareProfile": true,
    "manageFolders": true,
    "editProfile": true,
    "deleteProfile": true,
    "cloneProfile": true,
    "exportProfile": true,
    "updateUA": true,
    "addVpnUfoProxy": true,
    "runProfile": true,
    "runProfileWeb": true,
    "viewProfile": true,
    "addProfileTag": true,
    "removeProfileTag": true,
    "viewShareLinks": true,
    "createShareLinks": true,
    "updateShareLinks": true,
    "deleteShareLinks": true,
    "viewCustomExtensions": true
  },
  "proxyEnabled": true,
  "isAutoGenerated": true,
  "isBookmarksSynced": true,
  "defaultProps": {
    "profileNameIsDefault": true,
    "profileNotesIsDefault": true
  },
  "autoLang": true,
  "remoteOrbitaUrl": "<string>",
  "webGLMetadata": {
    "mode": "mask",
    "vendor": "Google Inc. (Intel)",
    "renderer": "ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)"
  },
  "fonts": {
    "families": [
      "Arial",
      "Helvetica",
      "Verdana"
    ],
    "enableMasking": true,
    "enableDomRect": true
  },
  "facebookAccountData": {
    "date": "<string>",
    "token": "<string>",
    "fbIdAccount": "<string>",
    "email": "<string>",
    "password": "<string>",
    "googleDriveUrl": "<string>",
    "fb2faToolUrl": "<string>",
    "fbUrl": "<string>",
    "uaVersion": "<string>",
    "cookies": "<string>",
    "notParsedData": [
      "<string>"
    ]
  },
  "order": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
workspaceId
string

Body

application/json
​
name
string

Profile name.

Example:

"My Test Profile"

​
notes
string

Here you can put some information about the profile that wil help you to navigate.

Example:

"Temporary profile for testing"

​
autoLang
boolean

If true, the browser will automatically change the language to the language of your location or proxy location if proxy is enabled.

Example:

true

​
lockEnabled
boolean
default:false

If enabled - other users will not be able to run this profile when its already running.

Example:

false

​
folderName
string
​
bookmarks
object

Bookmarks of the browser that will be created.

​
os
enum<string>

OS type. It should be the same with the OS you want to run the browser on.

Available options:
lin,
mac,
win,
android,
android-cloud
Example:

"win"

​
osSpec
enum<string>

Here you can specify OS specification. For example chip version for macos or version of windows.

Available options:
M1,
M2,
M3,
M4,
win11,
Example:

"win11"

​
devicePixelRatio
number

Parameter of mobile devices, tablets and notebooks. If you not sure what to put - leave it empty.

Example:

1

​
navigator
object
​
proxy
object
​
dns
string
default:""

Allows you to specify custom DNS (Domain Name System) settings for the browser profile.

Example:

"8.8.8.8"

​
timezone
object

The timezone configuration is a setting that controls how the browser handles time and date information.

​
geolocation
object

Geolocation in the browser is a feature that allows websites to access the user's geographical location.

​
audioContext
object

AudioContext is a configuration component that controls how Chromium handles the Web Audio API.

​
canvas
object

Canvas is a browser feature that utilizes the HTML5 Canvas API for rendering 2D and 3D graphics in web browsers.

​
fonts
object

Fonts are a configuration component that controls how Chromium handles the Fonts API.

​
mediaDevices
object

A feature that provides access to connected media input and output devices like cameras, microphones, and speakers.

​
webRTC
object

WebRTC in browser configuration refers to settings that control how the browser handles real-time communication protocols.

​
webGL
object

WebGL (Web Graphics Library) is a JavaScript API in Chromium-based browsers that allows websites to render interactive 2D and 3D graphics without requiring plugins. It provides direct access to the computer's GPU(Graphics Processing Unit) for accelerated rendering.

​
clientRects
object

Controls whether the client rectangle values are randomized.

​
webGLMetadata
object

Controls WebGL metadata such as vendor and renderer information.

​
chromeExtensions
string[]

List of Chrome extensions to be installed in the browser profile.

​
userChromeExtensions
string[]

List of custom Chrome extensions to be installed in the browser profile.

​
folders
string[]

List of folder identifiers associated with this browser profile for organization.

Response

200 - application/json
​
name
string
required
​
role
string
required
​
id
string
required
​
notes
string
required
​
browserType
string
required
​
lockEnabled
boolean
required
​
timezone
object
required
​
navigator
object
required
​
geolocation
object
required
​
debugMode
boolean
required
​
canBeRunning
boolean
required
​
isRunning
boolean
required
​
proxy
object
required
​
proxyType
string
required
​
proxyRegion
string
required
​
createdAt
string<date-time>
required

Date string

​
updatedAt
string<date-time>
required

Date string

​
lastActivity
string<date-time>
required

Date string

​
userChromeExtensions
string[]
required
​
permissions
object
required
​
remoteOrbitaUrl
string
required
​
webGLMetadata
object
required
​
isM1
boolean
​
isPinned
boolean
​
updateUALastChosenBrowserV
string
​
isRunDisabled
boolean
​
runDisabledReason
enum<string>
Available options:
unpaid-share
​
isWeb
boolean
​
os
object
​
osSpec
object
​
host
string
​
port
number
​
status
string
​
folders
string[]
​
sharedEmails
string[]
​
shareId
string
​
chromeExtensions
string[]
​
tags
string[]
​
proxyEnabled
boolean
​
isAutoGenerated
boolean
​
isBookmarksSynced
boolean
​
defaultProps
object
​
autoLang
boolean
​
fonts
object
​
facebookAccountData
object
​
order
number