Skip to main content

Create temporary browser instance

Please read the Material Usage Rules on this site.

Description: This method creates and starts a temporary browser instance with a one-time profile. The profile is not added to the profile list and is deleted together with its data after the browser is closed. To stop the instance, use Delete browser instance with the profileId from the response. All emulation parameters are optional.

Request parameters:​

ParameterTypeFormatDefaultDescription
workspaceIdintegerint64-1Workspace identifier. -1 means the default workspace.
proxyServerIdstringuuid(empty)Proxy server identifier (optional).
desktopNamestring(empty)Desktop environment name.
environmentTagsstring(empty)Tags used to configure the browser instance environment.
commandLineArgumentsstring(empty)Custom command line arguments to pass to the browser on startup
customFeaturesstring(empty)JSON object containing browser feature overrides.
screenstring(empty)Screen configuration settings. The allowed values are: "auto" to use value from fingerprint, "ignore" to use system value or "width x height" to set custom screen resolution (auto, ignore or or manual screen resolution entry, such as SVGA, WSVGA, HD+, etc. The complete list of manually configurable resolutions is provided below)
"SVGA" = 800x600; "0.69M3" = 960x720;
"0.59M9" = 1024x576; "WSVGA" = 1024x600;
"0.66MA" = 1024x640; "XGA" = 1024x768;
"1152x648" = 1152x648; "XGA+" = 1152x864;
"HD" = 1280x720; "WXGA" = 1280x768;
"WXGA+" = 1280x800; "SXGA-" = 1280x960;
"SXGA" = 1280x1024; "1360x768" = 1360x768;
"WXGA HD" = 1366x768; "SXGA+" = 1400x1050;
"WSXGA" = 1440x900; "1.56M3" = 1440x1080;
"1536x864" = 1536x864; "HD+" = 1600x900;
"UXGA" = 1600x1200; "WSXGA+" = 1680x1050;
"1832x1392" = 1832x1392; "FHD" = 1920x1080;
"WUXGA" = 1920x1200; "2.76M3" = 1920x1440;
"QWXGA" = 2048x1152; "QXGA" = 2048x1536;
"3.32MA" = 2304x1440; "WQHD" = 2560x1440;
"WQXGA" = 2560x1600; "QSXGA" = 2560x2048;
"5.18MA" = 2880x1800; "4K UHD-1" = 3840x2160;
"9.44M9" = 4096x2304; "5K" = 5120x2880;
"8K UHD-2" = 7680x4320;
cpustring(empty)CPU configuration settings. The allowed values are: "auto" to use value from fingerprint, "ignore" to use system value or integer number to set custom processor core count (auto, ignore, or number of cores ("2/4", "4/8", "6/12", "8/16", "10/20", "12/24", "14/28", "16/32", "32/64", "64/128"))
memorystring(empty)Memory configuration settings. Allowed values: "auto" - use the value from the fingerprint, "ignore" - use the system value, or an integer to specify a custom memory size (auto, ignore, or memory size ("2", "4", "8", "16", "32", "64", "128"))
languagestring(empty)Browser language settings. The allowed values are: "auto" to use value from fingerprint, "ignore" to use system value or language locale value (auto, ignore, or locale: Russian - ru English (United States) - en-US German - de French - fr Spanish - es English (United Kingdom) - en-GB
geoLocationstring(empty)Geographic location settings. The allowed values are: "auto" to use value from fingerprint, "ignore" to use system value. It is also possible to specify from one to seven floating point numbers that represent the following geo coordinates: Latitude, Longitude, Altitude, Accuracy, AltitudeAccuracy, Heading, Speed, Radius. Some coordinates can be skipped. For example, the following value sequence is valid: 10, , 40, , 60, 70 - means Latitude = 10, Longitude = random, Altitude = 40, Accuracy = random, AltitudeAccuracy = 60, Heading = 70, Speed = random, Radius = random (auto, ignore or coordinates (latitude, longitude, etc.))
timeZonestring(empty)Timezone settings. The allowed values are: "auto" to use value from fingerprint, "ignore" to use system value or custom timezone value (auto, ignore, or specific value (e.g. Europe/Moscow))
webGlstring(empty)WebGL configuration settings. The allowed values are: "auto" to use value from fingerprint, "ignore" to use system value. (auto or ignore)
webGpustring(empty)WebGPU configuration settings. The allowed values are: "on" to enable or "off" to disable this feature.(on or off)
webRtcstring(empty)WebRTC configuration settings. The allowed values are: "Emulate" to use value from fingerprint, "Real" to use system value or "Hide" to disable this feature.(Emulate, Real or Hide)
domRectstring(empty)DOM Rectangle configuration settings. The allowed values are: "Ignore" to disable this feature or "Noise" to use dom rect noising.(Ignore or Noise)
audiostring(empty)Audio configuration settings. The allowed values are: "on" to enable or "off" to disable this feature. (on or off)
fontsstring(empty)Font configuration settings. The allowed values are: "on" to enable or "off" to disable this feature. (on or off)
batterystring(empty)Battery configuration settings. The allowed values are: "on" to enable or "off" to disable this feature. (on or off)
pluginsstring(empty)Browser plugins configuration. The allowed values are: "on" to enable or "off" to disable this feature. (on or off)
speechVoicesstring(empty)Speech voices configuration. The allowed values are: "on" to enable or "off" to disable this feature. (on or off)
canvasstring(empty)Canvas settings. The allowed values are: Ignore to disable this feature or Noise to use noising.
mediaDevicesstring(empty)Media devices settings. The allowed values are: auto to use value from fingerprint, ignore to use real values or custom location values. You can specify from one to three integer numbers that represent the following values: AudioInput, AudioOutput and VideoInput The numbers can be skipped. For example, the following values are valid: 1,,5 - means AudioInput = 1, AudioOutput = random, VideoInput = 5
presetIdstringuuid(empty)Optional preset identifier used to initialize the profile configuration.
osVersionstring(empty)OS version for fingerprint selection. Allowed values: win10 or win11. If empty, the server auto-detects the host OS.
imagesVideosDownloadstring(empty)Images and videos download configuration. Allowed values: on to enable or off to disable.
windowSizeFromFingerprintstring(empty)Open the browser window exactly in the profile fingerprint screen resolution. Allowed values: on to enable or off to disable.

Request example:​

POST
CURL:

curl 'http://localhost:8160/v1/browser_instances/create_temporary?workspaceId=-1&proxyServerId=&desktopName=Desktop%201&environmentTags=&commandLineArguments=--disable-gpu&customFeatures=%7B%7D&screen=FHD&cpu=8%2F16&memory=8&language=en-US&geoLocation=auto&timeZone=Europe%2FMoscow&webGl=auto&webGpu=on&webRtc=Emulate&domRect=Noise&audio=on&fonts=on&battery=on&plugins=on&speechVoices=on&canvas=Noise&mediaDevices=1%2C1%2C1&presetId=&osVersion=win11&imagesVideosDownload=on&windowSizeFromFingerprint=on' \
  --request POST \
  --header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Text;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("http://localhost:8160/v1/browser_instances/create_temporary?workspaceId=-1&screen=FHD&cpu=8%2F16&memory=8&language=en-US&timeZone=Europe%2FMoscow&osVersion=win11&windowSizeFromFingerprint=on"),
    Headers =
    {
        { "Api-Token", "YOUR_SECRET_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Cube:

http://localhost:8160/v1/browser_instances/create_temporary?workspaceId=-1&screen=FHD&cpu=8/16&memory=8&language=en-US&timeZone=Europe/Moscow&osVersion=win11&windowSizeFromFingerprint=on

API response:​

Response codeResult
200 OKTemporary browser instance created
401 UnauthorizedUnauthorized
403 ForbiddenAccess forbidden
500 Internal Server ErrorInternal server error

Successful response (200 OK):

{
  "profileId": "123e4567-e89b-12d3-a456-426614174000",
  "processId": 1,
  "connectionString": null
}

Error response (500):

{
  "message": null
}