Models
ErrorobjectShow propertiesHide properties
FingerprintEnvelopeobjectShow propertiesHide properties
fingerprintobject · FingerprintrequiredNative 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
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.
0 = overrides-only mode (the common case).
navigatorobjectoptionalShow propertiesHide properties
81632screenobjectoptionalShow propertiesHide properties
srgbp3rec2020How often the claimed display refreshes. Absent means 60. See the refresh_rate field on the create/edit requests.
client_hintsobjectoptionalSec-CH-UA family (browser.vision calls this hints).
Show propertiesHide properties
Sec-CH-UA family (browser.vision calls this hints).
webglobjectoptionalShow propertiesHide properties
WebRTC handling mode.
autotcp_onlyblocknoiseobject · NoisePrefsoptionalPer-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
Show propertiesHide properties
Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
canvasobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
webglobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
audioobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
client_rectsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
sensorsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
fontsobject · NoiseBlockoptionalenabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Show propertiesHide properties
enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Per-profile entropy; 0 = derive automatically.
networkobjectoptionalShow propertiesHide properties
Local-network port-scan defense (ports_protection).
IANA name, or "auto" to resolve from the bound proxy at launch.
FingerprintobjectNative 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
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.
0 = overrides-only mode (the common case).
navigatorobjectoptionalShow propertiesHide properties
81632screenobjectoptionalShow propertiesHide properties
srgbp3rec2020How often the claimed display refreshes. Absent means 60. See the refresh_rate field on the create/edit requests.
client_hintsobjectoptionalSec-CH-UA family (browser.vision calls this hints).
Show propertiesHide properties
Sec-CH-UA family (browser.vision calls this hints).
webglobjectoptionalShow propertiesHide properties
WebRTC handling mode.
autotcp_onlyblocknoiseobject · NoisePrefsoptionalPer-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
Show propertiesHide properties
Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
canvasobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
webglobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
audioobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
client_rectsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
sensorsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
fontsobject · NoiseBlockoptionalenabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Show propertiesHide properties
enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Per-profile entropy; 0 = derive automatically.
networkobjectoptionalShow propertiesHide properties
Local-network port-scan defense (ports_protection).
IANA name, or "auto" to resolve from the bound proxy at launch.
NoisePrefsobjectPer-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
Show propertiesHide properties
Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
canvasobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
webglobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
audioobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
client_rectsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
sensorsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
fontsobject · NoiseBlockoptionalenabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Show propertiesHide properties
enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Per-profile entropy; 0 = derive automatically.
NoiseBlockobjectShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
CreateProfileRequestobjectShow propertiesHide properties
Bind a proxy already in the store (by id).
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.
Folder tag (ignored on /folders/{folder}/profiles, which wins).
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.
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.
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 · FingerprintrequiredStored verbatim. Get one from /fingerprint/new and edit as needed.
Show propertiesHide properties
Stored verbatim. Get one from /fingerprint/new and edit as needed.
0 = overrides-only mode (the common case).
navigatorobjectoptionalShow propertiesHide properties
81632screenobjectoptionalShow propertiesHide properties
srgbp3rec2020How often the claimed display refreshes. Absent means 60. See the refresh_rate field on the create/edit requests.
client_hintsobjectoptionalSec-CH-UA family (browser.vision calls this hints).
Show propertiesHide properties
Sec-CH-UA family (browser.vision calls this hints).
webglobjectoptionalShow propertiesHide properties
WebRTC handling mode.
autotcp_onlyblocknoiseobject · NoisePrefsoptionalPer-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
Show propertiesHide properties
Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
canvasobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
webglobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
audioobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
client_rectsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
sensorsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
fontsobject · NoiseBlockoptionalenabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Show propertiesHide properties
enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Per-profile entropy; 0 = derive automatically.
networkobjectoptionalShow propertiesHide properties
Local-network port-scan defense (ports_protection).
IANA name, or "auto" to resolve from the bound proxy at launch.
EditProfileRequestobjectAll fields optional; only what's present is changed.
Show propertiesHide properties
All fields optional; only what's present is changed.
"" unfiles (moves to All).
"" unbinds the proxy.
Proxy string; stored (deduped) + full-tested, then bound.
#rrggbb; "" goes back to the name-derived colour.
Replaces the whole list; [] loads none.
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 · FingerprintoptionalWhen present, REPLACES the stored fingerprint verbatim.
Show propertiesHide properties
When present, REPLACES the stored fingerprint verbatim.
0 = overrides-only mode (the common case).
navigatorobjectoptionalShow propertiesHide properties
81632screenobjectoptionalShow propertiesHide properties
srgbp3rec2020How often the claimed display refreshes. Absent means 60. See the refresh_rate field on the create/edit requests.
client_hintsobjectoptionalSec-CH-UA family (browser.vision calls this hints).
Show propertiesHide properties
Sec-CH-UA family (browser.vision calls this hints).
webglobjectoptionalShow propertiesHide properties
WebRTC handling mode.
autotcp_onlyblocknoiseobject · NoisePrefsoptionalPer-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
Show propertiesHide properties
Per-vector anti-fingerprint noise. Each block is {enabled, seed} (+ feature-specific knobs). enabled:false = pass-through.
canvasobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
webglobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
audioobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
client_rectsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
sensorsobject · NoiseBlockoptionalShow propertiesHide properties
Per-profile entropy; 0 = derive automatically.
fontsobject · NoiseBlockoptionalenabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Show propertiesHide properties
enabled:true hides a small deterministic per-profile subset of non-essential fonts (real host fonts otherwise pass through).
Per-profile entropy; 0 = derive automatically.
networkobjectoptionalShow propertiesHide properties
Local-network port-scan defense (ports_protection).
IANA name, or "auto" to resolve from the bound proxy at launch.
TempProfileRequestobjectShow propertiesHide properties
Library entry to base off; random match for platform when omitted.
Used to pick a random fingerprint when fingerprint_id is omitted; host OS when both omitted.
WindowsmacOSLinuxInline proxy string (not saved to the store).
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.
noiseobjectoptionalPer-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
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.
ExtensionobjectShow propertiesHide properties
Pass this in a profile's extensions.
@<unix_secs>.
Largest icon the manifest declares, as a data: URL. Null on the listing endpoint and on extensions that ship none.
AddExtensionRequestobjectExactly one of url or path.
Show propertiesHide properties
Exactly one of url or path.
A Chrome Web Store page, a bare 32-character extension id, or a direct link to a .crx / .zip.
A local .crx, .zip or unpacked folder on the launcher's machine.
BookmarkobjectShow propertiesHide properties
Launcher folder; empty means every profile.
BookmarkRequestobjectShow propertiesHide properties
Present updates that bookmark; absent creates one.
A bare host is fine; https:// is added.
Blank uses the address itself.
Empty (or absent) means every profile.
TrashEntryobjectShow propertiesHide properties
Unix seconds.
Unix seconds; the startup sweep removes anything past it.
The archive, which holds the account and not the caches.
ProfileMetaobjectLauncher-facing profile metadata (returned by create).
Show propertiesHide properties
Launcher-facing profile metadata (returned by create).
ISO-8601 or null.
Icon accent as #rrggbb; null means it is derived from the name, which is what the browser does when nothing is chosen.
Extension-library ids loaded at launch.
ProfileListItemobjectShow propertiesHide properties
ISO-8601 or null.
Icon accent as #rrggbb; null means it is derived from the name, which is what the browser does when nothing is chosen.
Extension-library ids loaded at launch.
cdpobject · CdpInfo· nullableoptionalChrome DevTools Protocol endpoint of a running profile.
Show propertiesHide properties
Chrome DevTools Protocol endpoint of a running profile.
Chrome-chosen remote-debugging port.
REST base (/json, /json/version).
Browser-level WS endpoint for Puppeteer/Playwright connect.
StoredProfileobjectFull 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
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.
_metaobjectoptionalShow propertiesHide properties
inline_proxyobject · ProxyEntry· nullableoptionalFull proxy (as embedded in _meta.inline_proxy).
Show propertiesHide properties
Full proxy (as embedded in _meta.inline_proxy).
socks5httphttpsBumped 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.
cdpobject · CdpInfo· nullableoptionalChrome DevTools Protocol endpoint of a running profile.
Show propertiesHide properties
Chrome DevTools Protocol endpoint of a running profile.
Chrome-chosen remote-debugging port.
REST base (/json, /json/version).
Browser-level WS endpoint for Puppeteer/Playwright connect.
CdpInfoobjectChrome DevTools Protocol endpoint of a running profile.
Show propertiesHide properties
Chrome DevTools Protocol endpoint of a running profile.
Chrome-chosen remote-debugging port.
REST base (/json, /json/version).
Browser-level WS endpoint for Puppeteer/Playwright connect.
RunningProfileobjectShow propertiesHide properties
cdpobject · CdpInfo· nullableoptionalChrome DevTools Protocol endpoint of a running profile.
Show propertiesHide properties
Chrome DevTools Protocol endpoint of a running profile.
Chrome-chosen remote-debugging port.
REST base (/json, /json/version).
Browser-level WS endpoint for Puppeteer/Playwright connect.
LibraryEntryobjectShow propertiesHide properties
WindowsmacOSLinuxChrome version string.
Part of the bundled starter set.
AddProxyRequestobjectA proxy string OR explicit fields (string wins).
Show propertiesHide properties
A proxy string OR explicit fields (string wins).
scheme://user:pass@host:port or host:port:user:pass.
socks5httphttpsProxySummaryobjectStored proxy without credentials.
Show propertiesHide properties
Stored proxy without credentials.
socks5httphttpsInformational tag (e.g. "US").
objectA cookie in a tool-friendly shape (compatible with EditThisCookie / Puppeteer exports; httpOnly/sameSite are accepted as aliases on import).
Show propertiesHide properties
A cookie in a tool-friendly shape (compatible with EditThisCookie / Puppeteer exports; httpOnly/sameSite are accepted as aliases on import).
Cookie host (Chromium host_key), e.g. ".example.com".
Unix seconds; null/absent = session cookie.
Case-insensitive on import.
StrictLaxNoneunspecifiedProxyEntryobjectFull proxy (as embedded in _meta.inline_proxy).
Show propertiesHide properties
Full proxy (as embedded in _meta.inline_proxy).
socks5httphttpsAutomationBranchstring · enum | objectWhere the run goes after a step. A plain string for the simple cases, an object for the ones carrying a value.
Show propertiesHide properties
Where the run goes after a step. A plain string for the simple cases, an object for the ones carrying a value.
AutomationBlockobjectOne step. kind and params are open; a module can add a kind this build has never heard of.
Show propertiesHide properties
One step. kind and params are open; a module can add a kind this build has never heard of.
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. |
The step's own fields, as the palette defines them.
Canvas position. Layout only; the run follows the branches.
Where the run goes after a step. A plain string for the simple cases, an object for the ones carrying a value.
Defaults to stop; carrying on after a click that found nothing is how a run types into the wrong page.
Parameter names emptied on export.
AutomationRunSettingsobjectShow propertiesHide properties
Browsers running at once; clamped to 1-64.
Passes over the blocks. 0 means run until hours is up.
Only meaningful when loops is 0.
Block id to start at; empty means the first.
Kept for projects saved before profiles became blocks; one thread each when set.
AutomationProjectobjectShow propertiesHide properties
blocksobject · AutomationBlock[]optionalShow propertiesHide properties
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. |
The step's own fields, as the palette defines them.
Canvas position. Layout only; the run follows the branches.
Where the run goes after a step. A plain string for the simple cases, an object for the ones carrying a value.
Defaults to stop; carrying on after a click that found nothing is how a run types into the wrong page.
Parameter names emptied on export.
runobject · AutomationRunSettingsoptionalShow propertiesHide properties
Browsers running at once; clamped to 1-64.
Passes over the blocks. 0 means run until hours is up.
Only meaningful when loops is 0.
Block id to start at; empty means the first.
Kept for projects saved before profiles became blocks; one thread each when set.
Unix seconds.
Unix seconds.
AutomationBundleobjectA project on its way to another machine.
Show propertiesHide properties
A project on its way to another machine.
An import refuses a number it does not know.
Unix seconds.
projectobject · AutomationProjectoptionalShow propertiesHide properties
blocksobject · AutomationBlock[]optionalShow propertiesHide properties
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. |
The step's own fields, as the palette defines them.
Canvas position. Layout only; the run follows the branches.
Where the run goes after a step. A plain string for the simple cases, an object for the ones carrying a value.
Defaults to stop; carrying on after a click that found nothing is how a run types into the wrong page.
Parameter names emptied on export.
runobject · AutomationRunSettingsoptionalShow propertiesHide properties
Browsers running at once; clamped to 1-64.
Passes over the blocks. 0 means run until hours is up.
Only meaningful when loops is 0.
Block id to start at; empty means the first.
Kept for projects saved before profiles became blocks; one thread each when set.
Unix seconds.
Unix seconds.
Module ids the steps need.
module_filesobject[]optionalThose 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
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.
The .wasm, gzipped then base64.
needsobject[]optionalWhat export blanked, so an import can ask for exactly that.
Show propertiesHide properties
What export blanked, so an import can ask for exactly that.
AutomationWorkerobjectOne browser inside a run.
Show propertiesHide properties
One browser inside a run.
1-based; 0 before the first pass starts.
queuedstartingrunningdonefailedstoppedAutomationRunobjectShow propertiesHide properties
Unix seconds.
workersobject · AutomationWorker[]optionalShow propertiesHide properties
1-based; 0 before the first pass starts.
queuedstartingrunningdonefailedstoppedThe tail the fleet window shows; the whole log is on disk under automation-runs/.
AutomationModuleobjectShow propertiesHide properties
File stem; also the prefix every one of its block kinds carries.
Block descriptors, in the same shape as the built-in palette.
Empty when the module loaded; otherwise why it did not.
Last updated on