Skip to main content
The Browser (kind: "web") is the environment H ships today: a managed, remote web browser the platform provisions per session. Reference a built-in browser by catalog name (like "h/browser"), or define one inline in an agent’s environments list. When you define a Browser inline, only id is required; every other field has a default. Reference a catalog entry instead and it supplies them for you.
FieldDefaultDescription
idrequiredCatalog identifier for the environment.
kind"web"Environment type. Currently only web.
width1200Viewport width in pixels. Must be a positive integer.
height1200Viewport height in pixels. Must be a positive integer.
start_url"https://www.bing.com"Initial URL to open.
session_idnullAttach to an existing remote browser session instead of provisioning a fresh one. When set, settings applied at provisioning time (such as network) are ignored.
mode"visual"How the agent perceives and drives the browser: visual, multimodal, or text. See Modes.
page_chars20000Characters of page text shown per page in text mode. Only meaningful in text mode; leave it at the default otherwise.
vault_idnullId of a vault to bind to this browser, letting the agent sign in to sites with secrets resolved from the vault. Must reference a vault in your organization. Omit to run without secret access.
browser_profile_idnullId of a browser profile to load into this browser, restoring saved cookies and storage so the agent starts the session already signed in. Must reference a profile in your organization. Omit to start with a fresh profile.
networknullNetwork settings for the session. Holds proxy_url to route the browser’s egress through your own proxy. Applied only when a new session is provisioned; ignored when session_id attaches to an existing one. See Proxy.

Next steps

Modes

How the agent perceives a page and the actions it can take in each mode.

Proxy

Route the browser’s egress through your own HTTP, HTTPS, or SOCKS proxy.

Profiles

Start a session already signed in from saved cookies and storage.