Skip to content
Local APIData models

BrowserCreateRequest schema ​

Version overview

BrowserCreateRequest

object
Fields
stringrequired
Browser profile name
minLength: 1maxLength: 32
object
Browser window size; defaults to 800 x 600 if omitted
Default{"width":800,"height":600}

Additional fields are not allowed.

objectrequired
Compatibility settings for the browser engine, fingerprint operating system, and User-Agent

Additional fields are not allowed.

string | null
Profile group ID; uses the default group if omitted or null
minLength: 1maxLength: 32
object[] | null
List of Puppeteer Cookie objects; each item must include at least name and value
maxItems: 500
string | null
Browser profile notes
maxLength: 5000
string | null
Browser startup arguments, in the same format as the profile configuration in the graphical interface
maxLength: 5000
object
Profile proxy settings; no proxy is used if omitted
Default{"mode":"none"}
string[]
List of existing account IDs from account management to bind
Default[]
maxItems: 100
object[]
Accounts to create and bind when creating the profile. Using this field also requires account creation permission.
Default[]
maxItems: 20
string[]
List of personal or team extension IDs to bind
Default[]
maxItems: 100
object
Common browser settings; if the object or any child field is omitted, the corresponding field defaults are used
Default{"image_size_limit_kb":null,"restore_last_session":true,"block_video_autoplay":false,"disable_video_preload":false,"mute_audio":false,"disable_translate_prompt":false,"disable_password_save_prompt":false,"block_notifications":false,"block_clipboard_read":false,"stop_open_on_network_error":false,"stop_open_on_ip_change":false,"stop_open_on_country_change":false,"search_engine_preset":null}

Additional fields are not allowed.

object
Browser fingerprint settings; each field uses its default mode if omitted
Default{"webrtc":{"mode":"based_on_ip"},"timezone":{"mode":"based_on_ip"},"geolocation":{"mode":"based_on_ip"},"language":{"mode":"based_on_ip"},"screen":{"mode":"random"},"fonts":{"mode":"random"},"noise":{"canvas":true,"webgl":true,"audio_context":true,"client_rects":true},"memory":{"mode":"random"},"cpu":{"mode":"random"},"do_not_track":{"mode":"default"},"port_scan_protection":{"mode":"enabled"},"hardware_acceleration":{"mode":"default"},"battery":{"mode":"random"},"media_devices":{"mode":"random"}}

Additional fields are not allowed.

boolean
Whether to randomize the fingerprint again whenever the profile is opened
Defaultfalse
ZYBrowser Local API documentation