Instant profiles

Introduction

Vision provides the ability to launch a “one-time” profile. This profile will be launched immediately after the launch request is executed, and upon closure, this profile will be deleted and unavailable for subsequent use. At the same time, data from the profile (cookies) will be included in the response to the profile closure request.

This feature is useful for automation specialists whose work does not involve using a profile after its initial launch and subsequent shutdown.

Important! All parameters described below are optional.

No parameters are required to start the profile; specify them only if you need to start the profile with specific values.

Base URL for launching Instant profile

GET
http://127.0.0.1:3030/start/instant

Use the GET method to run the profile without parameters. In this case, the profile will be run with a random fingerprint, and the OS fingerprint will match yours.

POST
http://127.0.0.1:3030/start/instant

Use the POST method to launch the profile with the parameters specified in the request body.

Base URL for stopping Instant profile

GET
http://127.0.0.1:3030/stop/instant/{PROFILE_ID}

Request

Request headers

Headers
Название
Тип / Значение
Описание
X-Token/X-Team-Token
String
Authorization token or team authorization token

Request body

Body
Название
Тип / Значение
Описание
name
String
Profile name
os
String
The name of the operating system of the profile being created. Available values: macos, windows, linux
version
Number
Browser version
smart
String
Smart Fingerprint mode. Available values: standard, enhanced
fingerprint
Object
Object with profile fingerprint
proxy
String
Proxy in the format: protocol://username:password@host:port
extensions
Array
An array with absolute paths to unpacked extensions, for example: D:\extensions\ID\0.7.0_0
cookies
Array
Cookies object
behavior
Object
Additional launch parameters, such as custom flags, headless mode, etc.

Fingerprint object

Navigator object

navigator
Название
Тип / Значение
Описание
user_agent
String
Profile's User-Agent
language
String
Local system language, e.g. en-GB
languages
Array
Array with profile languages
timezone
String
Profile time zone, for example: America/New_York or Europe/Samara
hardware_concurrency
Number
Number of CPU cores
device_memory
Number
Amount of RAM. Values above 8 will be interpreted by websites as 8GB.

You can get a list of available time zones by sending a request to the Local API. More details are available here.

The list of available languages can also be obtained by making a similar request.

Screen object

screen
Название
Тип / Значение
Описание
resolution
String
Browser profile screen resolution, for example: 1920x1080. Minimum value: 800x600
pixel_ratio
Float
The ratio of the current device's display resolution in physical pixels to its resolution in logical (CSS) pixels. Standard values: 1.0 for Windows, 2.0 for macOS with Retina.

webgl_renderer parameter

webgl_renderer
Название
Тип / Значение
Описание
webgl_renderer
String
Video card model, for example: Apple M3 or Intel(R) HD Graphics 530

You can get a list of available graphics cards by sending a request to the Local API. More details are available here.

media_devices object

media_devices
Название
Тип / Значение
Описание
audio_input
Number
Number of audio input devices
audio_output
Number
Number of audio output devices
video_input
Number
Number of video input devices

geolocation object

geolocation
Название
Тип / Значение
Описание
latitude
Number/Float
Latitude, specified as a floating point number, for example: 40.7128
longitude
Number/Float
Longitude, specified as a floating point number, for example: -74.006
accuracy
Number
Accuracy of geolocation

noise object

If noise does not need to be applied to any of the above parameters, the noise object can be omitted.

If noise needs to be specified for only one or two of the three parameters, the remaining parameters do not need to be specified in the noise object.

noise
Название
Тип / Значение
Описание
canvas
Boolean
Canvas noise: true or false
webgl
Boolean
WebGL noise: true or false
client_rects
Boolean
Client Rects noise: true or false

canvas parameter

If you need to disable Canvas, set the value to off. If you need Real mode, do not specify the canvas parameter in the fingerprint object.

canvas
Название
Тип / Значение
Описание
canvas
String
Available values: off

webgl parameter

If you need to disable WebGL, set the value to off. If you need Real mode, do not specify the webgl parameter in the fingerprint object.

webgl
Название
Тип / Значение
Описание
webgl
String
Available values: off

webrtc parameter

If you need to disable WebRTC, set the value to off. If you need to specify the value Manual, specify the IP address in string format, for example, 1.1.1.1. If you need Auto mode, do not specify the webrtc parameter in the fingerprint object.

webrtc
Название
Тип / Значение
Описание
webrtc
String
Available values: off or IP

ports_protection parameter

ports_protection
Название
Тип / Значение
Описание
ports_protection
Array
An array of ports that will be closed, for example: [3389, 5900, 5901]

behavior object

behavior
Название
Тип / Значение
Описание
urls
Array
Start URLs. When the profile is launched, the pages specified in this array will be opened.
args
Array
Custom flags
headless
Boolean
In the case of true, the profile will be launched in Headless mode.
remote_debugging_port
Number
If necessary, you can specify a specific port for subsequent connection to the profile.
timeout
Number
Timeout before launching the profile to check the proxy

Start Instant profile

Examples of requests to launch an Instant profile without parameters

1const url =
2  "http://127.0.0.1:3030/start/instant"; 
3
4const options = {
5  method: "GET",
6  headers: {
7    "X-Token": "Your Token", 
8  }, 
9};
10
11fetch(url, options)
12  .then((response) => {
13    response.json().then((data) => {
14      console.log(data);
15    });
16  })
17  .catch((error) => {
18    console.error(error);
19  });

Response

Response data

Response
Название
Тип / Значение
Описание
success
Boolean
In case of successful launch - true, in case of error - false
profile_id
String
ID of the running profile
port
Number
Port for connecting to a profile using automation libraries

Response example

1{
2  success: true,
3  profile_id: "039e50ce-6748-43c3-81ca-9d16aece007e",
4  port: 61453
5}

Examples of requests to launch an Instant profile with all parameters

1const url =
2  "http://127.0.0.1:3030/start/instant"; 
3
4const body = {
5  "name": "Profile 1",
6  "os": "macos",
7  "version": 142,
8  "smart": "standard",
9  "fingerprint": {
10    "navigator": {
11      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/142.0.0.0 Safari/537.36",
12      "language": "en-GB",
13      "languages": [
14        "en-GB",
15        "en",
16        "en-US",
17        "en"
18      ],
19      "timezone": "America/New_York",
20      "hardware_concurrency": 8,
21      "device_memory": 8
22    },
23    "screen": {
24      "resolution": "1920x1080",
25      "pixel_ratio": 2
26    },
27    "webgl_renderer": "Apple M3",
28    "media_devices": {
29      "audio_input": 1,
30      "audio_output": 1,
31      "video_input": 1
32    },
33    "geolocation": {
34      "latitude": 40.7128,
35      "longitude": -74.006,
36      "accuracy": 100
37    },
38    "noise": {
39      "canvas": true,
40      "webgl": true,
41      "client_rects": true
42    },
43    "canvas": "off",
44    "webgl": "off",
45    "webrtc": "1.1.1.1",
46    "ports_protection": [
47      3389,
48      5900,
49      5901
50    ]
51  },
52  "proxy": "socks5://user:pass@1.1.1.1:5555",
53  "extensions": [
54    "C:\\extension1",
55    "C:\\extension2"
56  ],
57  "cookies": [
58    {
59      "domain": ".google.com",
60      "name": "1P_JAR",
61      "value": "2021-11-10-11",
62      "path": "/",
63      "expires": 1639134293,
64      "secure": true,
65      "http_only": false,
66      "same_site": "none"
67    }
68  ],
69  "behavior": {
70    "urls": [
71      "https://google.com/"
72    ],
73    "args": [
74      "--flag"
75    ],
76    "headless": false,
77    "remote_debugging_port": 61374,
78    "timeout": 3
79  }
80}
81
82const options = {
83  method: "POST",
84  headers: {
85    "X-Token": "Your Token", 
86    "Content-Type": "application/json"
87  }, 
88  body: JSON.stringify(body)
89};
90
91fetch(url, options)
92  .then((response) => {
93    response.json().then((data) => {
94      console.log(data);
95    });
96  })
97  .catch((error) => {
98    console.error(error);
99  });

Response

Response data

Response
Название
Тип / Значение
Описание
success
Boolean
If the launch is successful, true; if there is an error, false.
profile_id
String
ID of the running profile
port
Number
Port for connecting to a profile using automation libraries

Response example

1{
2  success: true,
3  profile_id: "b437dea0-e465-4a18-b2b4-db2521df9eae",
4  port: 60756
5}

Stop Instant profile

Example of stopping an Instant profile

Please note that instead of PROFILE_ID, you need to insert the ID of the Instant profile that is running!

1const url =
2  "http://127.0.0.1:3030/stop/instant/PROFILE_ID"; 
3
4const options = {
5  method: "GET",
6  headers: {
7    "X-Token": "Your Token", 
8  }, 
9};
10
11fetch(url, options)
12  .then((response) => {
13    response.json().then((data) => {
14      console.log(data);
15    });
16  })
17  .catch((error) => {
18    console.error(error);
19  });

Response

Response data

Response
Название
Тип / Значение
Описание
success
Boolean
In case of successful shutdown - true, in case of error - false
profile_id
String
ID of the suspended profile
folder_id
String
Not used
cookies
Array
Cookies of the stopped profile in JSON format

Response example

1{
2  success: true,
3  profile_id: "75b4f9e6-fa6a-45a9-b272-f35d06a749d1",
4  folder_id: "00000000-0000-0000-0000-000000000000",
5  cookies: [{
6      "domain": ".google.com",
7      "name": "1P_JAR",
8      "value": "2021-11-10-11",
9      "path": "/",
10      "expires": 1639134293,
11      "secure": true,
12      "http_only": false,
13      "same_site": "none"
14    }]
15}