APIAPIs and integrationsShardX Launcher APIModels

Models

ErrorobjectShow propertiesHide properties
errorstringrequired
FingerprintEnvelopeobjectShow propertiesHide properties
fingerprintobject · Fingerprintrequired

Native FingerprintConfig. Documented sub-objects are the common ones; the object is open and stored verbatim by the create endpoints, so any field present here is round-tripped.

Show propertiesHide properties
namestringoptional
notesstringoptional
seedintegeroptional

0 = overrides-only mode (the common case).

navigatorobjectoptional
Show propertiesHide properties
user_agentstringoptional
platformstringoptional
hardware_concurrencyintegeroptional
device_memoryinteger · enumoptional
Possible values:81632
languagestringoptional
do_not_trackbooleanoptional
screenobjectoptional
Show propertiesHide properties
widthintegeroptional
heightintegeroptional
avail_widthintegeroptional
avail_heightintegeroptional
color_depthintegeroptional
device_pixel_rationumberoptional
color_gamutstring · enumoptional
Possible values:srgbp3rec2020
refresh_rateinteger· min: 24· max: 480optional

How often the claimed display refreshes. Absent means 60. See the refresh_rate field on the create/edit requests.

client_hintsobjectoptional

Sec-CH-UA family (browser.vision calls this hints).

Show propertiesHide properties
platformstringoptional
platform_versionstringoptional
architecturestringoptional
bitnessstringoptional
mobilebooleanoptional
webglobjectoptional
Show propertiesHide properties
unmasked_vendorstringoptional
unmasked_rendererstringoptional
webgpuobjectoptional
webrtcstring · enumoptional

WebRTC handling mode.

Possible values:autotcp_onlyblock
noiseobject · NoisePrefsoptional

Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.

Show propertiesHide properties
canvasobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

webglobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
audioobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
client_rectsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

max_offsetnumberoptional
sensorsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

fontsobject · NoiseBlockoptional

enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).

Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

networkobjectoptional
Show propertiesHide properties
blocked_portsinteger[]optional

Local-network port-scan defense (ports_protection).

timezonestringoptional

IANA name, or "auto" to resolve from the bound proxy at launch.

Fingerprintobject

Native FingerprintConfig. Documented sub-objects are the common ones; the object is open and stored verbatim by the create endpoints, so any field present here is round-tripped.

Show propertiesHide properties
namestringoptional
notesstringoptional
seedintegeroptional

0 = overrides-only mode (the common case).

navigatorobjectoptional
Show propertiesHide properties
user_agentstringoptional
platformstringoptional
hardware_concurrencyintegeroptional
device_memoryinteger · enumoptional
Possible values:81632
languagestringoptional
do_not_trackbooleanoptional
screenobjectoptional
Show propertiesHide properties
widthintegeroptional
heightintegeroptional
avail_widthintegeroptional
avail_heightintegeroptional
color_depthintegeroptional
device_pixel_rationumberoptional
color_gamutstring · enumoptional
Possible values:srgbp3rec2020
refresh_rateinteger· min: 24· max: 480optional

How often the claimed display refreshes. Absent means 60. See the refresh_rate field on the create/edit requests.

client_hintsobjectoptional

Sec-CH-UA family (browser.vision calls this hints).

Show propertiesHide properties
platformstringoptional
platform_versionstringoptional
architecturestringoptional
bitnessstringoptional
mobilebooleanoptional
webglobjectoptional
Show propertiesHide properties
unmasked_vendorstringoptional
unmasked_rendererstringoptional
webgpuobjectoptional
webrtcstring · enumoptional

WebRTC handling mode.

Possible values:autotcp_onlyblock
noiseobject · NoisePrefsoptional

Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.

Show propertiesHide properties
canvasobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

webglobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
audioobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
client_rectsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

max_offsetnumberoptional
sensorsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

fontsobject · NoiseBlockoptional

enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).

Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

networkobjectoptional
Show propertiesHide properties
blocked_portsinteger[]optional

Local-network port-scan defense (ports_protection).

timezonestringoptional

IANA name, or "auto" to resolve from the bound proxy at launch.

NoisePrefsobject

Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.

Show propertiesHide properties
canvasobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

webglobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
audioobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
client_rectsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

max_offsetnumberoptional
sensorsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

fontsobject · NoiseBlockoptional

enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).

Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

NoiseBlockobjectShow propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

CreateProfileRequestobjectShow propertiesHide properties
namestringoptional
notesstringoptional
proxy_idstringoptional

Bind a proxy already in the store (by id).

proxystringoptional

Attach a proxy by string (host:port:user:pass or scheme://user:pass@host:port). On a persistent profile it is added to the proxy store (deduped by endpoint) and full-tested (UDP + geo), then bound by id; so it appears in the proxy list and QUIC/WebRTC gating has a cached result. On a temporary profile it is attached inline (not stored). Ignored if proxy_id is set.

folderstringoptional

Folder tag (ignored on /folders/{folder}/profiles, which wins).

colorstringoptional

Accent for the profile's window icon and for the pill carrying its name in the omnibox. Omit it and the icon derives a colour from the name while the pill keeps the browser's own toolbar colour.

extensionsstring[]optional

Extension-library ids (GET /extensions), loaded at launch. An id the library does not hold is a 400 rather than a profile that silently starts without it.

refresh_rateinteger· min: 24· max: 480optional

Claimed display refresh rate, written into screen.refresh_rate. No web API reports it; a page measures it by timing requestAnimationFrame, which is why leaving it out is not neutral; absent means 60, what most machines report, rather than whatever the host's own screen does. Frames can only be slowed, so the effective rate is the closest whole division of the host's panel at or under this.

fingerprintobject · Fingerprintrequired

Stored verbatim. Get one from /fingerprint/new and edit as needed.

Show propertiesHide properties
namestringoptional
notesstringoptional
seedintegeroptional

0 = overrides-only mode (the common case).

navigatorobjectoptional
Show propertiesHide properties
user_agentstringoptional
platformstringoptional
hardware_concurrencyintegeroptional
device_memoryinteger · enumoptional
Possible values:81632
languagestringoptional
do_not_trackbooleanoptional
screenobjectoptional
Show propertiesHide properties
widthintegeroptional
heightintegeroptional
avail_widthintegeroptional
avail_heightintegeroptional
color_depthintegeroptional
device_pixel_rationumberoptional
color_gamutstring · enumoptional
Possible values:srgbp3rec2020
refresh_rateinteger· min: 24· max: 480optional

How often the claimed display refreshes. Absent means 60. See the refresh_rate field on the create/edit requests.

client_hintsobjectoptional

Sec-CH-UA family (browser.vision calls this hints).

Show propertiesHide properties
platformstringoptional
platform_versionstringoptional
architecturestringoptional
bitnessstringoptional
mobilebooleanoptional
webglobjectoptional
Show propertiesHide properties
unmasked_vendorstringoptional
unmasked_rendererstringoptional
webgpuobjectoptional
webrtcstring · enumoptional

WebRTC handling mode.

Possible values:autotcp_onlyblock
noiseobject · NoisePrefsoptional

Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.

Show propertiesHide properties
canvasobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

webglobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
audioobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
client_rectsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

max_offsetnumberoptional
sensorsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

fontsobject · NoiseBlockoptional

enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).

Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

networkobjectoptional
Show propertiesHide properties
blocked_portsinteger[]optional

Local-network port-scan defense (ports_protection).

timezonestringoptional

IANA name, or "auto" to resolve from the bound proxy at launch.

EditProfileRequestobject

All fields optional; only what's present is changed.

Show propertiesHide properties
namestringoptional
notesstringoptional
folderstringoptional

"" unfiles (moves to All).

proxy_idstringoptional

"" unbinds the proxy.

proxystringoptional

Proxy string; stored (deduped) + full-tested, then bound.

colorstringoptional

#rrggbb; "" goes back to the name-derived colour.

extensionsstring[]optional

Replaces the whole list; [] loads none.

refresh_rateinteger· min: 24· max: 480optional

Claimed display refresh rate, applied AFTER fingerprint and written into screen.refresh_rate. No web API reports it; a page measures it by timing requestAnimationFrame, which is why leaving it out is not neutral; absent means 60, what most machines report, rather than whatever the host's own screen does. Frames can only be slowed, so the effective rate is the closest whole division of the host's panel at or under this.

fingerprintobject · Fingerprintoptional

When present, REPLACES the stored fingerprint verbatim.

Show propertiesHide properties
namestringoptional
notesstringoptional
seedintegeroptional

0 = overrides-only mode (the common case).

navigatorobjectoptional
Show propertiesHide properties
user_agentstringoptional
platformstringoptional
hardware_concurrencyintegeroptional
device_memoryinteger · enumoptional
Possible values:81632
languagestringoptional
do_not_trackbooleanoptional
screenobjectoptional
Show propertiesHide properties
widthintegeroptional
heightintegeroptional
avail_widthintegeroptional
avail_heightintegeroptional
color_depthintegeroptional
device_pixel_rationumberoptional
color_gamutstring · enumoptional
Possible values:srgbp3rec2020
refresh_rateinteger· min: 24· max: 480optional

How often the claimed display refreshes. Absent means 60. See the refresh_rate field on the create/edit requests.

client_hintsobjectoptional

Sec-CH-UA family (browser.vision calls this hints).

Show propertiesHide properties
platformstringoptional
platform_versionstringoptional
architecturestringoptional
bitnessstringoptional
mobilebooleanoptional
webglobjectoptional
Show propertiesHide properties
unmasked_vendorstringoptional
unmasked_rendererstringoptional
webgpuobjectoptional
webrtcstring · enumoptional

WebRTC handling mode.

Possible values:autotcp_onlyblock
noiseobject · NoisePrefsoptional

Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.

Show propertiesHide properties
canvasobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

webglobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
audioobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

intensitynumberoptional
client_rectsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

max_offsetnumberoptional
sensorsobject · NoiseBlockoptional
Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

fontsobject · NoiseBlockoptional

enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).

Show propertiesHide properties
enabledbooleanoptional
seedintegeroptional

Per-profile entropy; 0 = derive automatically.

networkobjectoptional
Show propertiesHide properties
blocked_portsinteger[]optional

Local-network port-scan defense (ports_protection).

timezonestringoptional

IANA name, or "auto" to resolve from the bound proxy at launch.

TempProfileRequestobjectShow propertiesHide properties
fingerprint_idstringoptional

Library entry to base off; random match for platform when omitted.

platformstring · enumoptional

Used to pick a random fingerprint when fingerprint_id is omitted; host OS when both omitted.

Possible values:WindowsmacOSLinux
proxystringoptional

Inline proxy string (not saved to the store).

namestringoptional
folderstringoptional
refresh_rateinteger· min: 24· max: 480optional

Claimed display refresh rate, written into screen.refresh_rate. No web API reports it; a page measures it by timing requestAnimationFrame, which is why leaving it out is not neutral; absent means 60, what most machines report, rather than whatever the host's own screen does. Frames can only be slowed, so the effective rate is the closest whole division of the host's panel at or under this.

noiseobjectoptional

Per-vector fingerprint noise. Omitted vectors keep their defaults (disabled). Two formats can be combined: shorthand {"canvas": true, "webgl": true}, which also applies the UI default intensity to webgl and client_rects, and a full object such as {"canvas": {"enabled": true, "seed": 42}}, matching the format returned by GET /profiles/{id}.

Fields are merged with the existing vector settings. A missing or zero seed generates a stable value from the profile ID.

Show propertiesHide properties
canvasanyoptional
webglanyoptional
audioanyoptional
client_rectsanyoptional
sensorsanyoptional
fontsanyoptional
ExtensionobjectShow propertiesHide properties
idstringoptional

Pass this in a profile's extensions.

namestringoptional
versionstringoptional
descriptionstringoptional
size_bytesinteger · int64optional
added_atstringoptional

@<unix_secs>.

iconstring· nullableoptional

Largest icon the manifest declares, as a data: URL. Null on the listing endpoint and on extensions that ship none.

AddExtensionRequestobject

Exactly one of url or path.

Show propertiesHide properties
urlstringoptional

A Chrome Web Store page, a bare 32-character extension id, or a direct link to a .crx / .zip.

pathstringoptional

A local .crx, .zip or unpacked folder on the launcher's machine.

BookmarkobjectShow propertiesHide properties
idstring · uuidoptional
titlestringoptional
urlstringoptional
folderstringoptional

Launcher folder; empty means every profile.

BookmarkRequestobjectShow propertiesHide properties
idstringoptional

Present updates that bookmark; absent creates one.

urlstringrequired

A bare host is fine; https:// is added.

titlestringoptional

Blank uses the address itself.

folderstringoptional

Empty (or absent) means every profile.

TrashEntryobjectShow propertiesHide properties
idstring · uuidoptional
namestringoptional
folderstringoptional
deleted_atinteger · int64optional

Unix seconds.

expires_atinteger · int64optional

Unix seconds; the startup sweep removes anything past it.

size_bytesinteger · int64optional

The archive, which holds the account and not the caches.

ProfileMetaobject

Launcher-facing profile metadata (returned by create).

Show propertiesHide properties
idstring · uuidoptional
namestringoptional
notesstringoptional
proxy_idstring· nullableoptional
last_launched_atstring· nullableoptional

ISO-8601 or null.

created_atstring· nullableoptional
pinnedbooleanoptional
folderstringoptional
colorstring· nullableoptional

Icon accent as #rrggbb; null means it is derived from the name, which is what the browser does when nothing is chosen.

extensionsstring[]optional

Extension-library ids loaded at launch.

ProfileListItemobjectShow propertiesHide properties
idstring · uuidoptional
namestringoptional
notesstringoptional
proxy_idstring· nullableoptional
last_launched_atstring· nullableoptional

ISO-8601 or null.

created_atstring· nullableoptional
pinnedbooleanoptional
folderstringoptional
colorstring· nullableoptional

Icon accent as #rrggbb; null means it is derived from the name, which is what the browser does when nothing is chosen.

extensionsstring[]optional

Extension-library ids loaded at launch.

runningbooleanoptional
pidinteger · int64· nullableoptional
cdpobject · CdpInfo· nullableoptional

Chrome DevTools Protocol endpoint of a running profile.

Show propertiesHide properties
portintegeroptional

Chrome-chosen remote-debugging port.

http_urlstringoptional

REST base (/json, /json/version).

web_socket_debugger_urlstringoptional

Browser-level WS endpoint for Puppeteer/Playwright connect.

StoredProfileobject

Full on-disk profile: the _meta envelope plus the flattened FingerprintConfig (all Fingerprint fields appear at the top level). running/cdp are present only while the profile runs.

Show propertiesHide properties
_metaobjectoptional
Show propertiesHide properties
idstring · uuidoptional
proxy_idstring· nullableoptional
inline_proxyobject · ProxyEntry· nullableoptional

Full proxy (as embedded in _meta.inline_proxy).

Show propertiesHide properties
idstringoptional
namestringoptional
kindstring · enumoptional
Possible values:socks5httphttps
hoststringoptional
portintegeroptional
usernamestringoptional
passwordstringoptional
countrystringoptional
notesstringoptional
last_launched_atstring· nullableoptional
created_atstring· nullableoptional
pinnedbooleanoptional
folderstringoptional
temporarybooleanoptional
revintegeroptional

Bumped by every write. The desktop editor sends back the number it opened the profile at, so a save that would land on top of a change made through this API is refused rather than silently reverting it. API edits are never refused; they read the profile and write it back in one step.

runningbooleanoptional
cdpobject · CdpInfo· nullableoptional

Chrome DevTools Protocol endpoint of a running profile.

Show propertiesHide properties
portintegeroptional

Chrome-chosen remote-debugging port.

http_urlstringoptional

REST base (/json, /json/version).

web_socket_debugger_urlstringoptional

Browser-level WS endpoint for Puppeteer/Playwright connect.

CdpInfoobject

Chrome DevTools Protocol endpoint of a running profile.

Show propertiesHide properties
portintegeroptional

Chrome-chosen remote-debugging port.

http_urlstringoptional

REST base (/json, /json/version).

web_socket_debugger_urlstringoptional

Browser-level WS endpoint for Puppeteer/Playwright connect.

RunningProfileobjectShow propertiesHide properties
profile_idstringoptional
pidinteger · int64optional
cdpobject · CdpInfo· nullableoptional

Chrome DevTools Protocol endpoint of a running profile.

Show propertiesHide properties
portintegeroptional

Chrome-chosen remote-debugging port.

http_urlstringoptional

REST base (/json, /json/version).

web_socket_debugger_urlstringoptional

Browser-level WS endpoint for Puppeteer/Playwright connect.

LibraryEntryobjectShow propertiesHide properties
idstringoptional
labelstringoptional
platformstring · enumoptional
Possible values:WindowsmacOSLinux
chromestringoptional

Chrome version string.

gpustringoptional
builtinbooleanoptional

Part of the bundled starter set.

AddProxyRequestobject

A proxy string OR explicit fields (string wins).

Show propertiesHide properties
proxystringoptional

scheme://user:pass@host:port or host:port:user:pass.

kindstring · enumoptional
Possible values:socks5httphttps
hoststringoptional
portintegeroptional
usernamestringoptional
passwordstringoptional
namestringoptional
countrystringoptional
notesstringoptional
ProxySummaryobject

Stored proxy without credentials.

Show propertiesHide properties
idstringoptional
namestringoptional
kindstring · enumoptional
Possible values:socks5httphttps
hoststringoptional
portintegeroptional
countrystringoptional

Informational tag (e.g. "US").

Cookieobject

A cookie in a tool-friendly shape (compatible with EditThisCookie / Puppeteer exports; httpOnly/sameSite are accepted as aliases on import).

Show propertiesHide properties
domainstringrequired

Cookie host (Chromium host_key), e.g. ".example.com".

namestringrequired
valuestringrequired
pathstring· default: "/"optional
expiresnumber· nullableoptional

Unix seconds; null/absent = session cookie.

secureboolean· default: falseoptional
http_onlyboolean· default: falseoptional
same_sitestring · enumoptional

Case-insensitive on import.

Possible values:StrictLaxNoneunspecified
ProxyEntryobject

Full proxy (as embedded in _meta.inline_proxy).

Show propertiesHide properties
idstringoptional
namestringoptional
kindstring · enumoptional
Possible values:socks5httphttps
hoststringoptional
portintegeroptional
usernamestringoptional
passwordstringoptional
countrystringoptional
notesstringoptional
AutomationBranchstring · enum | object

Where the run goes after a step. A plain string for the simple cases, an object for the ones carrying a value.

Show propertiesHide properties
AutomationBlockobject

One step. kind and params are open; a module can add a kind this build has never heard of.

Show propertiesHide properties
idstringoptional
kindstringoptional

A built-in palette kind (goto, click, type, profile.create, var.set, ...) or module:<module id>:<block>.

On a mobile profile, common actions use touch input: click taps, rightClick performs a long press, and scroll and swipe use touch gestures. hover is unavailable because mobile devices have no pointer. The following mobile-only steps are rejected on desktop profiles:

| kind | params | action | | --- | --- | --- | | touch.tap | selector or x+y, tapCount (1-3), timeout | Tap the target. | | touch.longPress | selector or x+y, timeout | Press and hold. | | touch.swipe | selector or x+y, dx, dy, timeout | Swipe. | | touch.drag | selector, to, holdMs, timeout | Drag an element. | | touch.pinch | scale, selector or x+y | Pinch to zoom. Values above 1 zoom out. | | screen.rotate | angle (0/90/180/270), turnMs, into | Rotate the device. into stores the new screen.orientation.type. |

labelstringoptional
paramsobjectoptional

The step's own fields, as the palette defines them.

enabledboolean· default: trueoptional
xnumberoptional

Canvas position. Layout only; the run follows the branches.

ynumberoptional
on_donestring · enum | objectoptional

Where the run goes after a step. A plain string for the simple cases, an object for the ones carrying a value.

on_failany · AutomationBranchoptional

Defaults to stop; carrying on after a click that found nothing is how a run types into the wrong page.

secretsstring[]optional

Parameter names emptied on export.

AutomationRunSettingsobjectShow propertiesHide properties
threadsinteger· default: 1optional

Browsers running at once; clamped to 1-64.

loopsinteger· default: 1optional

Passes over the blocks. 0 means run until hours is up.

hoursnumberoptional

Only meaningful when loops is 0.

startstringoptional

Block id to start at; empty means the first.

profilesstring[]optional

Kept for projects saved before profiles became blocks; one thread each when set.

AutomationProjectobjectShow propertiesHide properties
idstring · uuidoptional
namestringoptional
notesstringoptional
blocksobject · AutomationBlock[]optional
Show propertiesHide properties
idstringoptional
kindstringoptional

A built-in palette kind (goto, click, type, profile.create, var.set, ...) or module:<module id>:<block>.

On a mobile profile, common actions use touch input: click taps, rightClick performs a long press, and scroll and swipe use touch gestures. hover is unavailable because mobile devices have no pointer. The following mobile-only steps are rejected on desktop profiles:

| kind | params | action | | --- | --- | --- | | touch.tap | selector or x+y, tapCount (1-3), timeout | Tap the target. | | touch.longPress | selector or x+y, timeout | Press and hold. | | touch.swipe | selector or x+y, dx, dy, timeout | Swipe. | | touch.drag | selector, to, holdMs, timeout | Drag an element. | | touch.pinch | scale, selector or x+y | Pinch to zoom. Values above 1 zoom out. | | screen.rotate | angle (0/90/180/270), turnMs, into | Rotate the device. into stores the new screen.orientation.type. |

labelstringoptional
paramsobjectoptional

The step's own fields, as the palette defines them.

enabledboolean· default: trueoptional
xnumberoptional

Canvas position. Layout only; the run follows the branches.

ynumberoptional
on_donestring · enum | objectoptional

Where the run goes after a step. A plain string for the simple cases, an object for the ones carrying a value.

on_failany · AutomationBranchoptional

Defaults to stop; carrying on after a click that found nothing is how a run types into the wrong page.

secretsstring[]optional

Parameter names emptied on export.

runobject · AutomationRunSettingsoptional
Show propertiesHide properties
threadsinteger· default: 1optional

Browsers running at once; clamped to 1-64.

loopsinteger· default: 1optional

Passes over the blocks. 0 means run until hours is up.

hoursnumberoptional

Only meaningful when loops is 0.

startstringoptional

Block id to start at; empty means the first.

profilesstring[]optional

Kept for projects saved before profiles became blocks; one thread each when set.

created_atintegeroptional

Unix seconds.

updated_atintegeroptional

Unix seconds.

AutomationBundleobject

A project on its way to another machine.

Show propertiesHide properties
formatintegeroptional

An import refuses a number it does not know.

exported_atintegeroptional

Unix seconds.

projectobject · AutomationProjectoptional
Show propertiesHide properties
idstring · uuidoptional
namestringoptional
notesstringoptional
blocksobject · AutomationBlock[]optional
Show propertiesHide properties
idstringoptional
kindstringoptional

A built-in palette kind (goto, click, type, profile.create, var.set, ...) or module:<module id>:<block>.

On a mobile profile, common actions use touch input: click taps, rightClick performs a long press, and scroll and swipe use touch gestures. hover is unavailable because mobile devices have no pointer. The following mobile-only steps are rejected on desktop profiles:

| kind | params | action | | --- | --- | --- | | touch.tap | selector or x+y, tapCount (1-3), timeout | Tap the target. | | touch.longPress | selector or x+y, timeout | Press and hold. | | touch.swipe | selector or x+y, dx, dy, timeout | Swipe. | | touch.drag | selector, to, holdMs, timeout | Drag an element. | | touch.pinch | scale, selector or x+y | Pinch to zoom. Values above 1 zoom out. | | screen.rotate | angle (0/90/180/270), turnMs, into | Rotate the device. into stores the new screen.orientation.type. |

labelstringoptional
paramsobjectoptional

The step's own fields, as the palette defines them.

enabledboolean· default: trueoptional
xnumberoptional

Canvas position. Layout only; the run follows the branches.

ynumberoptional
on_donestring · enum | objectoptional

Where the run goes after a step. A plain string for the simple cases, an object for the ones carrying a value.

on_failany · AutomationBranchoptional

Defaults to stop; carrying on after a click that found nothing is how a run types into the wrong page.

secretsstring[]optional

Parameter names emptied on export.

runobject · AutomationRunSettingsoptional
Show propertiesHide properties
threadsinteger· default: 1optional

Browsers running at once; clamped to 1-64.

loopsinteger· default: 1optional

Passes over the blocks. 0 means run until hours is up.

hoursnumberoptional

Only meaningful when loops is 0.

startstringoptional

Block id to start at; empty means the first.

profilesstring[]optional

Kept for projects saved before profiles became blocks; one thread each when set.

created_atintegeroptional

Unix seconds.

updated_atintegeroptional

Unix seconds.

modulesstring[]optional

Module ids the steps need.

module_filesobject[]optional

Those modules' files, carried inside the bundle so an imported project can run where it lands. A module missing from disk at export time is left out here but still named in modules. On import, a module already installed under the same id is kept as it is rather than overwritten.

Show propertiesHide properties
idstringoptional
wasmstringoptional

The .wasm, gzipped then base64.

needsobject[]optional

What export blanked, so an import can ask for exactly that.

Show propertiesHide properties
block_idstringoptional
labelstringoptional
paramsstring[]optional
AutomationWorkerobject

One browser inside a run.

Show propertiesHide properties
profile_idstringoptional
profile_namestringoptional
passintegeroptional

1-based; 0 before the first pass starts.

stepintegeroptional
steps_totalintegeroptional
statusstring · enumoptional
Possible values:queuedstartingrunningdonefailedstopped
notestringoptional
AutomationRunobjectShow propertiesHide properties
project_idstring · uuidoptional
project_namestringoptional
started_atintegeroptional

Unix seconds.

runningbooleanoptional
workersobject · AutomationWorker[]optional
Show propertiesHide properties
profile_idstringoptional
profile_namestringoptional
passintegeroptional

1-based; 0 before the first pass starts.

stepintegeroptional
steps_totalintegeroptional
statusstring · enumoptional
Possible values:queuedstartingrunningdonefailedstopped
notestringoptional
logstring[]optional

The tail the fleet window shows; the whole log is on disk under automation-runs/.

AutomationModuleobjectShow propertiesHide properties
idstringoptional

File stem; also the prefix every one of its block kinds carries.

namestringoptional
pathstringoptional
blocksobject[]optional

Block descriptors, in the same shape as the built-in palette.

errorstringoptional

Empty when the module loaded; otherwise why it did not.

Last updated on

On this page