Skip to main content
GET
Retrieve an environment
Retrieves one environment’s full specification, including pre-built h/ environments. Returns the environment object.

Path parameters

string
required
The environment’s id (e.g. h/browser or my-browser). Slash-containing identifiers are supported.

Response

The environment object, also returned by create, list, update, and patch. A browser (kind: "web") carries the fields below. A desktop (kind: "desktop") carries only id, kind, host, session_id, lazy, settle_s, and screenshot_max_width. Field meanings are on Create an environment.
string
Catalog identifier. h/ ids are H’s reserved, read-only environments.
string
web or desktop.
string
cloud or user_device.
string
Initial URL.
boolean
Whether the browser runs without a visible window.
string | null
Existing browser session to attach to.
object
{"type": "visual", "width", "height", "markdown"} or {"type": "text", "chunk_size"}.
boolean
Whether the browser starts on first use.
number
Seconds the agent waits after each action.
string | null
Bound vault.
string | null
Browser profile loaded at start.
boolean
Whether your default browser profile is loaded.
boolean
Whether the final browser state is saved back into the profile.
object | null
Proxy settings: managed_proxy or proxy_url.

Examples

Response

Errors